Hello,
I don't know if there is already something similar before. Here two screenshots from a patch 'rectangle-FR-help.pd' (for help in french about [rectangle] from GEM) and its 'automatic' equivalent in PHP/HTML. Do you think it is interresting to keep an online documentation always update from the '*-help.pd' file ? (it works also in subpatch : the blue line 'pourvoir' is the help in the subpatch [pd pourvoir]). It is possible to add more informations on the HTML/PHP (download the *-help.pd for example, or links to patchs using this object, etc.). I keep in mind a Mathieu's remark I think it is true/good : "it is better and more simple to make the help directly in the help-patch" (Mathieu, I hope it is a good translation ! ;). Sorry for the size of the .png. ++
Jack
On Thu, 20 May 2010, Jack wrote:
Here two screenshots from a patch 'rectangle-FR-help.pd' (for help in french about [rectangle] from GEM) and its 'automatic' equivalent in PHP/HTML.
My question is : how do you make that conversion ? because that conversion is based on assumptions, and those assumptions may not be portable between the different conventions for making help patches (various different PDDP templates, the GFDP system, Miller's help, GEM's help, etc)
Do you think it is interresting to keep an online documentation always update from the '*-help.pd' file ?
It's good to the extent that it makes things searchable on google and stuff.
I keep in mind a Mathieu's remark I think it is true/good : "it is better and more simple to make the help directly in the help-patch" (Mathieu, I hope it is a good translation ! ;).
Je me souviens pas d'avoir dit ça de même.
You should check your citations. For my lines, it's easy, I only used email and IRC, no voice. Then I probably was explaining why. I don't especially like my opinions to be quoted without their explanations. I don't tend to value opinions without justifications.
_ _ __ ___ _____ ________ _____________ _____________________ ... | Mathieu Bouchard, Montréal, Québec. téléphone: +1.514.383.3801
Hello,
Le mercredi 26 mai 2010 à 11:39 -0400, Mathieu Bouchard a écrit :
On Thu, 20 May 2010, Jack wrote:
Here two screenshots from a patch 'rectangle-FR-help.pd' (for help in french about [rectangle] from GEM) and its 'automatic' equivalent in PHP/HTML.
My question is : how do you make that conversion ? because that conversion is based on assumptions, and those assumptions may not be portable between the different conventions for making help patches (various different PDDP templates, the GFDP system, Miller's help, GEM's help, etc)
All you need is an abstraction (pure-pd) called 'helpSeparator'. You have to put it between the example patch and the description. On the capture (patch.png), this is the black rectangle over 'DESCRIPTION'.
Then, a PHP script running on the server where there is the help files files analize this '-help.pd' and return an HTML document (html.png).
This system works also if you use subpatch in you '-help.pd' as 'gemwin-help.pd' does ([pd viewing], [pd buffering], etc.). In my 'rectangle-FR-help.pd', there is a [pd pourvoir] in [pd gemwin] with the same abstraction 'helpSeparator' inside. You can see this on the html.png (starting with the blue line 'pourvoir').
For the arborescence (?) to the 'rectangle-FR-help.pd' i do this : gem -> help -> FR -> rectangle-FR-help.pd.
I wondered if it would be possible to define the language with the next version of Pd (with new GUI) ? Then a 'help' on an object will choose the right directory for the help (here FR) ? ++
Jack
Do you think it is interresting to keep an online documentation always update from the '*-help.pd' file ?
It's good to the extent that it makes things searchable on google and stuff.
Yes, with this method, it would be easy to generate an (always) update version of the help documentation in HTML and accessible with a browser.
I keep in mind a Mathieu's remark I think it is true/good : "it is better and more simple to make the help directly in the help-patch" (Mathieu, I hope it is a good translation ! ;).
Je me souviens pas d'avoir dit ça de même.
Si, si, c'était sur IRC, je crois ;) But, I don't have trace of this... The problem was : developpers don't want to build differents systems of help patch and prefer to do it directly with Pd. I don't put quote anymore ! :) ++
Jack
You should check your citations. For my lines, it's easy, I only used email and IRC, no voice. Then I probably was explaining why. I don't especially like my opinions to be quoted without their explanations. I don't tend to value opinions without justifications.
_ _ __ ___ _____ ________ _____________ _____________________ ... | Mathieu Bouchard, Montréal, Québec. téléphone: +1.514.383.3801
-
Jack -
Mathieu Bouchard