Quantcast

Re: [Tiki-devel] RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [Tiki-devel] RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Brendan Ferguson
Ok. I see that:

1. Others are not willing make the changes
2. The commit was not appreciated

r61165 will solve this.

We also will need to find someone else to integrate the existing documentation on doc.tiki.org into preferences in SVN. I was gong to quickly do it, but its clear to me that the obligation is greater than I can handle.

Wiki links work in prefs, so searching for them would also remove working ones.

Brendan



On Wed, Feb 1, 2017 at 4:52 AM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

Hi Brendan,

I understand that documenting is extremely long. What you were working on may be partially based on a documentation page I wrote years ago. I only documented the wiki, because it took me a day or more to verify what I wrote was correct and I kind of gave up before writing more.

 

I also understand that you did not necessarily author the text you added, and that is fine, but as the wiki can be written by anyone, there is still a responsibility of developers to vet what is imported from doc.tiki.org.

 

I also understand that the prioritization you propose might be considered more efficient, unfortunately it will not happen unless:

·         You proceed to a review yourself

·         A note in the commit message specifies that a review is warranted

·         A note in the code specifies that a review is warranted

 

And even a note in the commit message can be considered lost in practice. In other words, in practice, the second step won’t happen, unless the developer adds a code comment. Even such a note will hardly find someone willing to finish the job.

 

In practice, what could happen is that a user will notice a forgotten error, and will consider fixing it. The problem here is that it may take 10 times longer for someone to fix an error this way than if it is spotted during code review. Even a regular developer will need to identify the affected file/line and open it. And if fixing involves changing a translated string, the fix may cause losses of translations unless extra effort is made to keep existing translations, assuming these translations do not have the problem in the English string. And if we fix a problem which was copied from the documentation, the documentation will still be broken.

 

My message was not criticism and I was not claiming fixing these issues was important. There has to be a balance between reviewing and fixing. Bugs are unavoidable in practice. We just need to approach the right balance, and to realize that due to the issues above, that balance may involve more reviewing.

 

Now, regarding the main specific issue here, the removal/identification of internal links could be automated by searching for specific link syntax (“((“ and “))”).

 

Philippe Cloutier
Registre foncier

Systèmes d’information

Ministère de l'Énergie et des Ressources naturelles

Québec (Québec)  G1H 6R1

Téléphone : <a href="tel:(418)%20627-6282" value="+14186276282" target="_blank">418 627-6282, poste 2209

philippe.cloutier.externe@mern.gouv.qc.ca
mern.gouv.qc.ca

 

De : Brendan Ferguson [mailto:[hidden email]]
Envoyé : 30 janvier 2017 18:58
À : Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]>
Objet : Re: RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

 

I spent hours trying to get features documented. I combined outdated pages on doc.tiki with new and very empty pages on doc.tiki along with the documentation in SVN. It took me all day long to do one preference page. Tying to get them all sorted out. There was so much material that often times I didnt even read the descriptions of the preferences if it looked like they were populated well.

So i appreciate what your saying, but its super low priority for me. I stripped most of the internal links myself when copying the documentation from the doc.tiki site. I didnt write any of the descriptions, they were all copied.

At this point im happy to have the changes you suggested. Dont feel as though these preferences are mine. I wont take offense if you commit a change to make them better.

Right now I am coding a script to help me sync the preferences on doc.tiki.org with the ones in SVN. The documentation on doc.tiki.org is a mess and mostly missing or REALLY outdated. Im hoping to at least get it all up to date with the help of this script.

At some point, it will become more important in this whole process to correct the little issues, so any help you can lend in that regard is appreciated.

Brendan

 

On Tue, Jan 31, 2017 at 2:54 AM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

Thanks Brendan. A couple remarks...

There are a few internal links (first and last preferences) which won't work in code.

In feature_create_webhelp, "an self-contained" should read "a self-contained".
________________________________________
De : [hidden email] [[hidden email]]
Envoyé : 30 janvier 2017 03:36
À : [hidden email]
Objet : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Revision: 61132
          http://sourceforge.net/p/tikiwiki/code/61132
Author:   drsassafras
Date:     2017-01-30 08:36:48 +0000 (Mon, 30 Jan 2017)
Log Message:
-----------
[DOC] Adding pref descriptions from doc.tiki.org

Modified Paths:
--------------
    trunk/lib/prefs/feature.php

Modified: trunk/lib/prefs/feature.php
===================================================================
--- trunk/lib/prefs/feature.php 2017-01-30 06:25:32 UTC (rev 61131)
+++ trunk/lib/prefs/feature.php 2017-01-30 08:36:48 UTC (rev 61132)
@@ -2096,7 +2096,7 @@
                ),
                'feature_wiki_export' => array(
                        'name' => tra('Export'),
-            'description' => tra('permit exporting wiki pages'),
+            'description' => tra('If enabled, users can export individual pages and structure pages content as a file (requires  tiki_p_admin_wiki ((permission))).'),
                        'type' => 'flag',
                        'default' => 'n',
                ),
@@ -2120,7 +2120,7 @@
                ),
                'feature_history' => array(
                        'name' => tra('History'),
-            'description' => tra(''),
+            'description' => tra('If enabled, users with permission can see the history of each Wiki page. '),
                        'type' => 'flag',
                        'help' => 'History',
                        'default' => 'y',
@@ -2165,7 +2165,7 @@
                ),
                'feature_wiki_ratings' => array(
                        'name' => tra('Rating'),
-            'description' => tra(''),
+            'description' => tra('This allows you to add a poll from polls feature to any wiki page.  The poll is unique to the page, created from a "poll template" which is created in the Polls feature: set a poll\'s \'active\' drop-down to "template". You may have to adjust your groups permissions for tiki_p_wiki_view_ratings and tiki_p_wiki_vote_ratings.'),
                        'type' => 'flag',
                        'help' => 'Rating',
                        'dependencies' => array(
@@ -2175,7 +2175,7 @@
                ),
                'feature_backlinks' => array(
                        'name' => tra('Backlinks'),
-            'description' => tra(''),
+            'description' => tra('Allows users to view a list of pages, called backlinks, that link to the current page. '),
                        'type' => 'flag',
                        'help' => 'Backlinks',
                        'default' => 'n',
@@ -2189,7 +2189,7 @@
                ),
                'feature_wiki_rankings' => array(
                        'name' => tra('Rankings'),
-            'description' => tra(''),
+            'description' => tra('If enabled, users can see several charts or rankings about the Wiki.'),
                        'type' => 'flag',
                        'default' => 'n',
                ),
@@ -2237,7 +2237,7 @@
                ),
                'feature_create_webhelp' => array(
                        'name' => tra('Create webhelp from structure'),
-            'description' => tra(''),
+            'description' => tra('If enabled, the ((Structure Admin)) page will include a new option for generating ((WebHelp)) (an self-contained, HTML "help" version of the Wiki structure). Use this option to distribute Wiki pages to offline users in a usable format.'),
                        'type' => 'flag',
                        'default' => 'n',
                ),

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
Tikiwiki-cvs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-cvs

 



------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
TikiWiki-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[Tiki-devel] RE : RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Cloutier, Philippe (RESSOURCE EXTERNE)
I am sorry to see this, although I will not oppose. I am not sure what your first item means, but I wonder how you see the second, given that the one comment I have seen about r61132 mentioned appreciation.

Can you clarify what you mean by "Wiki links work in prefs, so searching for them would also remove working ones." ?


De : Brendan Ferguson [[hidden email]]
Envoyé : 31 janvier 2017 19:50
À : Tiki developers
Objet : Re: [Tiki-devel] RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Ok. I see that:
1. Others are not willing make the changes
2. The commit was not appreciated

r61165 will solve this.

We also will need to find someone else to integrate the existing documentation on doc.tiki.org into preferences in SVN. I was gong to quickly do it, but its clear to me that the obligation is greater than I can handle.

Wiki links work in prefs, so searching for them would also remove working ones.

Brendan



On Wed, Feb 1, 2017 at 4:52 AM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

Hi Brendan,

I understand that documenting is extremely long. What you were working on may be partially based on a documentation page I wrote years ago. I only documented the wiki, because it took me a day or more to verify what I wrote was correct and I kind of gave up before writing more.

 

I also understand that you did not necessarily author the text you added, and that is fine, but as the wiki can be written by anyone, there is still a responsibility of developers to vet what is imported from doc.tiki.org.

 

I also understand that the prioritization you propose might be considered more efficient, unfortunately it will not happen unless:

·         You proceed to a review yourself

·         A note in the commit message specifies that a review is warranted

·         A note in the code specifies that a review is warranted

 

And even a note in the commit message can be considered lost in practice. In other words, in practice, the second step won’t happen, unless the developer adds a code comment. Even such a note will hardly find someone willing to finish the job.

 

In practice, what could happen is that a user will notice a forgotten error, and will consider fixing it. The problem here is that it may take 10 times longer for someone to fix an error this way than if it is spotted during code review. Even a regular developer will need to identify the affected file/line and open it. And if fixing involves changing a translated string, the fix may cause losses of translations unless extra effort is made to keep existing translations, assuming these translations do not have the problem in the English string. And if we fix a problem which was copied from the documentation, the documentation will still be broken.

 

My message was not criticism and I was not claiming fixing these issues was important. There has to be a balance between reviewing and fixing. Bugs are unavoidable in practice. We just need to approach the right balance, and to realize that due to the issues above, that balance may involve more reviewing.

 

Now, regarding the main specific issue here, the removal/identification of internal links could be automated by searching for specific link syntax (“((“ and “))”).

 

Philippe Cloutier
Registre foncier

Systèmes d’information

Ministère de l'Énergie et des Ressources naturelles

Québec (Québec)  G1H 6R1

Téléphone : <a href="tel:(418)%20627-6282" value="&#43;14186276282" target="_blank">418 627-6282, poste 2209

philippe.cloutier.externe@mern.gouv.qc.ca
mern.gouv.qc.ca

 

De : Brendan Ferguson [mailto:[hidden email]]
Envoyé : 30 janvier 2017 18:58
À : Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]>
Objet : Re: RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

 

I spent hours trying to get features documented. I combined outdated pages on doc.tiki with new and very empty pages on doc.tiki along with the documentation in SVN. It took me all day long to do one preference page. Tying to get them all sorted out. There was so much material that often times I didnt even read the descriptions of the preferences if it looked like they were populated well.

So i appreciate what your saying, but its super low priority for me. I stripped most of the internal links myself when copying the documentation from the doc.tiki site. I didnt write any of the descriptions, they were all copied.

At this point im happy to have the changes you suggested. Dont feel as though these preferences are mine. I wont take offense if you commit a change to make them better.

Right now I am coding a script to help me sync the preferences on doc.tiki.org with the ones in SVN. The documentation on doc.tiki.org is a mess and mostly missing or REALLY outdated. Im hoping to at least get it all up to date with the help of this script.

At some point, it will become more important in this whole process to correct the little issues, so any help you can lend in that regard is appreciated.

Brendan

 

On Tue, Jan 31, 2017 at 2:54 AM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

Thanks Brendan. A couple remarks...

There are a few internal links (first and last preferences) which won't work in code.

In feature_create_webhelp, "an self-contained" should read "a self-contained".
________________________________________
De : [hidden email] [[hidden email]]
Envoyé : 30 janvier 2017 03:36
À : [hidden email]
Objet : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Revision: 61132
          http://sourceforge.net/p/tikiwiki/code/61132
Author:   drsassafras
Date:     2017-01-30 08:36:48 +0000 (Mon, 30 Jan 2017)
Log Message:
-----------
[DOC] Adding pref descriptions from doc.tiki.org

Modified Paths:
--------------
    trunk/lib/prefs/feature.php

Modified: trunk/lib/prefs/feature.php
===================================================================
--- trunk/lib/prefs/feature.php 2017-01-30 06:25:32 UTC (rev 61131)
+++ trunk/lib/prefs/feature.php 2017-01-30 08:36:48 UTC (rev 61132)
@@ -2096,7 +2096,7 @@
                ),
                'feature_wiki_export' => array(
                        'name' => tra('Export'),
-            'description' => tra('permit exporting wiki pages'),
+            'description' => tra('If enabled, users can export individual pages and structure pages content as a file (requires  tiki_p_admin_wiki ((permission))).'),
                        'type' => 'flag',
                        'default' => 'n',
                ),
@@ -2120,7 +2120,7 @@
                ),
                'feature_history' => array(
                        'name' => tra('History'),
-            'description' => tra(''),
+            'description' => tra('If enabled, users with permission can see the history of each Wiki page. '),
                        'type' => 'flag',
                        'help' => 'History',
                        'default' => 'y',
@@ -2165,7 +2165,7 @@
                ),
                'feature_wiki_ratings' => array(
                        'name' => tra('Rating'),
-            'description' => tra(''),
+            'description' => tra('This allows you to add a poll from polls feature to any wiki page.  The poll is unique to the page, created from a "poll template" which is created in the Polls feature: set a poll\'s \'active\' drop-down to "template". You may have to adjust your groups permissions for tiki_p_wiki_view_ratings and tiki_p_wiki_vote_ratings.'),
                        'type' => 'flag',
                        'help' => 'Rating',
                        'dependencies' => array(
@@ -2175,7 +2175,7 @@
                ),
                'feature_backlinks' => array(
                        'name' => tra('Backlinks'),
-            'description' => tra(''),
+            'description' => tra('Allows users to view a list of pages, called backlinks, that link to the current page. '),
                        'type' => 'flag',
                        'help' => 'Backlinks',
                        'default' => 'n',
@@ -2189,7 +2189,7 @@
                ),
                'feature_wiki_rankings' => array(
                        'name' => tra('Rankings'),
-            'description' => tra(''),
+            'description' => tra('If enabled, users can see several charts or rankings about the Wiki.'),
                        'type' => 'flag',
                        'default' => 'n',
                ),
@@ -2237,7 +2237,7 @@
                ),
                'feature_create_webhelp' => array(
                        'name' => tra('Create webhelp from structure'),
-            'description' => tra(''),
+            'description' => tra('If enabled, the ((Structure Admin)) page will include a new option for generating ((WebHelp)) (an self-contained, HTML "help" version of the Wiki structure). Use this option to distribute Wiki pages to offline users in a usable format.'),
                        'type' => 'flag',
                        'default' => 'n',
                ),

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
Tikiwiki-cvs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-cvs

 



------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
TikiWiki-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [Tiki-devel] RE : RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Brendan Ferguson
Appreciation is perhaps not the right word. Its really a matter of time and obligation.

"Now, regarding the main specific issue here, the removal/identification of internal links could be automated by searching for specific link syntax (“((“ and “))”)."

That would also remove working links.


On Wed, Feb 1, 2017 at 1:08 PM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:
I am sorry to see this, although I will not oppose. I am not sure what your first item means, but I wonder how you see the second, given that the one comment I have seen about r61132 mentioned appreciation.

Can you clarify what you mean by "Wiki links work in prefs, so searching for them would also remove working ones." ?


De : Brendan Ferguson [[hidden email]]
Envoyé : 31 janvier 2017 19:50
À : Tiki developers
Objet : Re: [Tiki-devel] RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Ok. I see that:
1. Others are not willing make the changes
2. The commit was not appreciated

r61165 will solve this.

We also will need to find someone else to integrate the existing documentation on doc.tiki.org into preferences in SVN. I was gong to quickly do it, but its clear to me that the obligation is greater than I can handle.

Wiki links work in prefs, so searching for them would also remove working ones.

Brendan



On Wed, Feb 1, 2017 at 4:52 AM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

Hi Brendan,

I understand that documenting is extremely long. What you were working on may be partially based on a documentation page I wrote years ago. I only documented the wiki, because it took me a day or more to verify what I wrote was correct and I kind of gave up before writing more.

 

I also understand that you did not necessarily author the text you added, and that is fine, but as the wiki can be written by anyone, there is still a responsibility of developers to vet what is imported from doc.tiki.org.

 

I also understand that the prioritization you propose might be considered more efficient, unfortunately it will not happen unless:

·         You proceed to a review yourself

·         A note in the commit message specifies that a review is warranted

·         A note in the code specifies that a review is warranted

 

And even a note in the commit message can be considered lost in practice. In other words, in practice, the second step won’t happen, unless the developer adds a code comment. Even such a note will hardly find someone willing to finish the job.

 

In practice, what could happen is that a user will notice a forgotten error, and will consider fixing it. The problem here is that it may take 10 times longer for someone to fix an error this way than if it is spotted during code review. Even a regular developer will need to identify the affected file/line and open it. And if fixing involves changing a translated string, the fix may cause losses of translations unless extra effort is made to keep existing translations, assuming these translations do not have the problem in the English string. And if we fix a problem which was copied from the documentation, the documentation will still be broken.

 

My message was not criticism and I was not claiming fixing these issues was important. There has to be a balance between reviewing and fixing. Bugs are unavoidable in practice. We just need to approach the right balance, and to realize that due to the issues above, that balance may involve more reviewing.

 

Now, regarding the main specific issue here, the removal/identification of internal links could be automated by searching for specific link syntax (“((“ and “))”).

 

Philippe Cloutier
Registre foncier

Systèmes d’information

Ministère de l'Énergie et des Ressources naturelles

Québec (Québec)  G1H 6R1

Téléphone : <a href="tel:(418)%20627-6282" value="+14186276282" target="_blank">418 627-6282, poste 2209

philippe.cloutier.externe@mern.gouv.qc.ca
mern.gouv.qc.ca

 

De : Brendan Ferguson [mailto:[hidden email]]
Envoyé : 30 janvier 2017 18:58
À : Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]>
Objet : Re: RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

 

I spent hours trying to get features documented. I combined outdated pages on doc.tiki with new and very empty pages on doc.tiki along with the documentation in SVN. It took me all day long to do one preference page. Tying to get them all sorted out. There was so much material that often times I didnt even read the descriptions of the preferences if it looked like they were populated well.

So i appreciate what your saying, but its super low priority for me. I stripped most of the internal links myself when copying the documentation from the doc.tiki site. I didnt write any of the descriptions, they were all copied.

At this point im happy to have the changes you suggested. Dont feel as though these preferences are mine. I wont take offense if you commit a change to make them better.

Right now I am coding a script to help me sync the preferences on doc.tiki.org with the ones in SVN. The documentation on doc.tiki.org is a mess and mostly missing or REALLY outdated. Im hoping to at least get it all up to date with the help of this script.

At some point, it will become more important in this whole process to correct the little issues, so any help you can lend in that regard is appreciated.

Brendan

 

On Tue, Jan 31, 2017 at 2:54 AM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

Thanks Brendan. A couple remarks...

There are a few internal links (first and last preferences) which won't work in code.

In feature_create_webhelp, "an self-contained" should read "a self-contained".
________________________________________
De : [hidden email] [[hidden email]]
Envoyé : 30 janvier 2017 03:36
À : [hidden email]
Objet : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Revision: 61132
          http://sourceforge.net/p/tikiwiki/code/61132
Author:   drsassafras
Date:     2017-01-30 08:36:48 +0000 (Mon, 30 Jan 2017)
Log Message:
-----------
[DOC] Adding pref descriptions from doc.tiki.org

Modified Paths:
--------------
    trunk/lib/prefs/feature.php

Modified: trunk/lib/prefs/feature.php
===================================================================
--- trunk/lib/prefs/feature.php 2017-01-30 06:25:32 UTC (rev 61131)
+++ trunk/lib/prefs/feature.php 2017-01-30 08:36:48 UTC (rev 61132)
@@ -2096,7 +2096,7 @@
                ),
                'feature_wiki_export' => array(
                        'name' => tra('Export'),
-            'description' => tra('permit exporting wiki pages'),
+            'description' => tra('If enabled, users can export individual pages and structure pages content as a file (requires  tiki_p_admin_wiki ((permission))).'),
                        'type' => 'flag',
                        'default' => 'n',
                ),
@@ -2120,7 +2120,7 @@
                ),
                'feature_history' => array(
                        'name' => tra('History'),
-            'description' => tra(''),
+            'description' => tra('If enabled, users with permission can see the history of each Wiki page. '),
                        'type' => 'flag',
                        'help' => 'History',
                        'default' => 'y',
@@ -2165,7 +2165,7 @@
                ),
                'feature_wiki_ratings' => array(
                        'name' => tra('Rating'),
-            'description' => tra(''),
+            'description' => tra('This allows you to add a poll from polls feature to any wiki page.  The poll is unique to the page, created from a "poll template" which is created in the Polls feature: set a poll\'s \'active\' drop-down to "template". You may have to adjust your groups permissions for tiki_p_wiki_view_ratings and tiki_p_wiki_vote_ratings.'),
                        'type' => 'flag',
                        'help' => 'Rating',
                        'dependencies' => array(
@@ -2175,7 +2175,7 @@
                ),
                'feature_backlinks' => array(
                        'name' => tra('Backlinks'),
-            'description' => tra(''),
+            'description' => tra('Allows users to view a list of pages, called backlinks, that link to the current page. '),
                        'type' => 'flag',
                        'help' => 'Backlinks',
                        'default' => 'n',
@@ -2189,7 +2189,7 @@
                ),
                'feature_wiki_rankings' => array(
                        'name' => tra('Rankings'),
-            'description' => tra(''),
+            'description' => tra('If enabled, users can see several charts or rankings about the Wiki.'),
                        'type' => 'flag',
                        'default' => 'n',
                ),
@@ -2237,7 +2237,7 @@
                ),
                'feature_create_webhelp' => array(
                        'name' => tra('Create webhelp from structure'),
-            'description' => tra(''),
+            'description' => tra('If enabled, the ((Structure Admin)) page will include a new option for generating ((WebHelp)) (an self-contained, HTML "help" version of the Wiki structure). Use this option to distribute Wiki pages to offline users in a usable format.'),
                        'type' => 'flag',
                        'default' => 'n',
                ),

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
Tikiwiki-cvs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-cvs

 




------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
TikiWiki-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [Tiki-devel] RE : RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Cloutier, Philippe (RESSOURCE EXTERNE)

 

De : Brendan Ferguson [mailto:[hidden email]]
Envoyé : 1 février 2017 00:00
À : Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]>
Cc : Tiki developers <[hidden email]>
Objet : Re: RE : [Tiki-devel] RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

 

[…]


"Now, regarding the main specific issue here, the removal/identification of internal links could be automated by searching for specific link syntax (“((“ and “))”)."

That would also remove working links.

 

[Philippe Cloutier] I guess we misunderstand. The descriptions were copied from doc.tiki.org to Tiki’s PHP code. The internal link syntax does not work in the description field. This syntax needs to be either removed or converted to HTML links.

 

On Wed, Feb 1, 2017 at 1:08 PM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

I am sorry to see this, although I will not oppose. I am not sure what your first item means, but I wonder how you see the second, given that the one comment I have seen about r61132 mentioned appreciation.

Can you clarify what you mean by "Wiki links work in prefs, so searching for them would also remove working ones." ?


De : Brendan Ferguson [[hidden email]]
Envoyé : 31 janvier 2017 19:50
À : Tiki developers
Objet : Re: [Tiki-devel] RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Ok. I see that:

1. Others are not willing make the changes

2. The commit was not appreciated

r61165 will solve this.

 

We also will need to find someone else to integrate the existing documentation on doc.tiki.org into preferences in SVN. I was gong to quickly do it, but its clear to me that the obligation is greater than I can handle.

 

Wiki links work in prefs, so searching for them would also remove working ones.

 

Brendan

 

On Wed, Feb 1, 2017 at 4:52 AM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

Hi Brendan,

I understand that documenting is extremely long. What you were working on may be partially based on a documentation page I wrote years ago. I only documented the wiki, because it took me a day or more to verify what I wrote was correct and I kind of gave up before writing more.

 

I also understand that you did not necessarily author the text you added, and that is fine, but as the wiki can be written by anyone, there is still a responsibility of developers to vet what is imported from doc.tiki.org.

 

I also understand that the prioritization you propose might be considered more efficient, unfortunately it will not happen unless:

·         You proceed to a review yourself

·         A note in the commit message specifies that a review is warranted

·         A note in the code specifies that a review is warranted

 

And even a note in the commit message can be considered lost in practice. In other words, in practice, the second step won’t happen, unless the developer adds a code comment. Even such a note will hardly find someone willing to finish the job.

 

In practice, what could happen is that a user will notice a forgotten error, and will consider fixing it. The problem here is that it may take 10 times longer for someone to fix an error this way than if it is spotted during code review. Even a regular developer will need to identify the affected file/line and open it. And if fixing involves changing a translated string, the fix may cause losses of translations unless extra effort is made to keep existing translations, assuming these translations do not have the problem in the English string. And if we fix a problem which was copied from the documentation, the documentation will still be broken.

 

My message was not criticism and I was not claiming fixing these issues was important. There has to be a balance between reviewing and fixing. Bugs are unavoidable in practice. We just need to approach the right balance, and to realize that due to the issues above, that balance may involve more reviewing.

 

Now, regarding the main specific issue here, the removal/identification of internal links could be automated by searching for specific link syntax (“((“ and “))”).

 

Philippe Cloutier
Registre foncier

Systèmes d’information

Ministère de l'Énergie et des Ressources naturelles

Québec (Québec)  G1H 6R1

Téléphone : <a href="tel:(418)%20627-6282" target="_blank">418 627-6282, poste 2209

philippe.cloutier.externe@...
mern.gouv.qc.ca

 

De : Brendan Ferguson [mailto:[hidden email]]
Envoyé : 30 janvier 2017 18:58
À : Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]>
Objet : Re: RE : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

 

I spent hours trying to get features documented. I combined outdated pages on doc.tiki with new and very empty pages on doc.tiki along with the documentation in SVN. It took me all day long to do one preference page. Tying to get them all sorted out. There was so much material that often times I didnt even read the descriptions of the preferences if it looked like they were populated well.

So i appreciate what your saying, but its super low priority for me. I stripped most of the internal links myself when copying the documentation from the doc.tiki site. I didnt write any of the descriptions, they were all copied.

At this point im happy to have the changes you suggested. Dont feel as though these preferences are mine. I wont take offense if you commit a change to make them better.

Right now I am coding a script to help me sync the preferences on doc.tiki.org with the ones in SVN. The documentation on doc.tiki.org is a mess and mostly missing or REALLY outdated. Im hoping to at least get it all up to date with the help of this script.

At some point, it will become more important in this whole process to correct the little issues, so any help you can lend in that regard is appreciated.

Brendan

 

On Tue, Jan 31, 2017 at 2:54 AM, Cloutier, Philippe (RESSOURCE EXTERNE) <[hidden email]> wrote:

Thanks Brendan. A couple remarks...

There are a few internal links (first and last preferences) which won't work in code.

In feature_create_webhelp, "an self-contained" should read "a self-contained".
________________________________________
De : [hidden email] [[hidden email]]
Envoyé : 30 janvier 2017 03:36
À : [hidden email]
Objet : [Tikiwiki-cvs/svn] SF.net SVN: tikiwiki:[61132] trunk/lib/prefs/feature.php

Revision: 61132
          http://sourceforge.net/p/tikiwiki/code/61132
Author:   drsassafras
Date:     2017-01-30 08:36:48 +0000 (Mon, 30 Jan 2017)
Log Message:
-----------
[DOC] Adding pref descriptions from doc.tiki.org

Modified Paths:
--------------
    trunk/lib/prefs/feature.php

Modified: trunk/lib/prefs/feature.php
===================================================================
--- trunk/lib/prefs/feature.php 2017-01-30 06:25:32 UTC (rev 61131)
+++ trunk/lib/prefs/feature.php 2017-01-30 08:36:48 UTC (rev 61132)
@@ -2096,7 +2096,7 @@
                ),
                'feature_wiki_export' => array(
                        'name' => tra('Export'),
-            'description' => tra('permit exporting wiki pages'),
+            'description' => tra('If enabled, users can export individual pages and structure pages content as a file (requires  tiki_p_admin_wiki ((permission))).'),
                        'type' => 'flag',
                        'default' => 'n',
                ),
@@ -2120,7 +2120,7 @@
                ),
                'feature_history' => array(
                        'name' => tra('History'),
-            'description' => tra(''),
+            'description' => tra('If enabled, users with permission can see the history of each Wiki page. '),
                        'type' => 'flag',
                        'help' => 'History',
                        'default' => 'y',
@@ -2165,7 +2165,7 @@
                ),
                'feature_wiki_ratings' => array(
                        'name' => tra('Rating'),
-            'description' => tra(''),
+            'description' => tra('This allows you to add a poll from polls feature to any wiki page.  The poll is unique to the page, created from a "poll template" which is created in the Polls feature: set a poll\'s \'active\' drop-down to "template". You may have to adjust your groups permissions for tiki_p_wiki_view_ratings and tiki_p_wiki_vote_ratings.'),
                        'type' => 'flag',
                        'help' => 'Rating',
                        'dependencies' => array(
@@ -2175,7 +2175,7 @@
                ),
                'feature_backlinks' => array(
                        'name' => tra('Backlinks'),
-            'description' => tra(''),
+            'description' => tra('Allows users to view a list of pages, called backlinks, that link to the current page. '),
                        'type' => 'flag',
                        'help' => 'Backlinks',
                        'default' => 'n',
@@ -2189,7 +2189,7 @@
                ),
                'feature_wiki_rankings' => array(
                        'name' => tra('Rankings'),
-            'description' => tra(''),
+            'description' => tra('If enabled, users can see several charts or rankings about the Wiki.'),
                        'type' => 'flag',
                        'default' => 'n',
                ),
@@ -2237,7 +2237,7 @@
                ),
                'feature_create_webhelp' => array(
                        'name' => tra('Create webhelp from structure'),
-            'description' => tra(''),
+            'description' => tra('If enabled, the ((Structure Admin)) page will include a new option for generating ((WebHelp)) (an self-contained, HTML "help" version of the Wiki structure). Use this option to distribute Wiki pages to offline users in a usable format.'),
                        'type' => 'flag',
                        'default' => 'n',
                ),

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
Tikiwiki-cvs mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-cvs

 

 

 


------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
TikiWiki-devel mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/tikiwiki-devel
Loading...