From: Van de B. <van...@gm...> - 2011-11-03 19:46:03
|
Hi, What I miss and what is really needed is a reference for functions. I know there is a help page: http://semantic-mediawiki.org/wiki/Category:Parser_hooks but it is still not convenient. I want to see function names, just "info", "set", "ask", "show". Instead I see long descriptions: "Adding tooltips", "Argument declaration in templates"… I spend time guessing what does it mean. Remember: I am talking about reference, not a tutorial. I know, there is a redirection page, and "Help:info" will be redirected to "Help:Adding tooltips", but the problem is that function names are not listed in "Category:Parser hooks". It is also not logical, because the table at the top od the page contains column "Parser hook", and I expect it should be parse hook name (e. g. "info") and not slightly modified description. Look: Parser hook Description Adding tooltips Add an icon with tooltip If there are no objections, I will rename "Adding tooltips" to "info", "Setting values" to set, etc. Van. |
From: Stephan G. <s7...@gm...> - 2011-11-03 20:00:59
|
Am 03.11.2011 20:45, schrieb Van de Bugger: > If there are no objections, I will rename "Adding tooltips" to "info", > "Setting values" to set, etc. Maybe make it something like 'Adding tooltips: #info', so it can serve as both tutorial and reference. Cheers, Stephan |
From: Jeroen De D. <jer...@gm...> - 2011-11-03 20:18:33
|
Hey, Not sure renaming the pages is the best approach. Why not just add another field to the template for the actual parser hook name, and display it in the table? You can of course also redirect Help:parserhookname to it's current equivalent for extra navigation convenience. Either way, if you see a way to make it better - go for it - it's a wiki after all :) Cheers -- Jeroen De Dauw http://www.bn2vs.com Don't panic. Don't be evil. -- |
From: Dan B. <dan...@gm...> - 2011-11-03 22:06:53
|
On 3 November 2011 19:45, Van de Bugger <van...@gm...> wrote: > Hi, > > What I miss and what is really needed is a reference for functions. I > know there is a help page: > > http://semantic-mediawiki.org/wiki/Category:Parser_hooks > > but it is still not convenient. I want to see function names, just > "info", "set", "ask", "show". Instead I see long descriptions: "Adding > tooltips", "Argument declaration in templates"… I spend time guessing > what does it mean. Remember: I am talking about reference, not a > tutorial. I know, there is a redirection page, and "Help:info" will be > redirected to "Help:Adding tooltips", but the problem is that function > names are not listed in "Category:Parser hooks". > > It is also not logical, because the table at the top od the page > contains column "Parser hook", and I expect it should be parse hook name > (e. g. "info") and not slightly modified description. Look: > > Parser hook Description > Adding tooltips Add an icon with tooltip > > If there are no objections, I will rename "Adding tooltips" to "info", > "Setting values" to set, etc. Perhaps just make some redirects? I agree that 'tutorial-style' documentation is great when you're beginning, but when you're developing, you want 'reference-style' documentation. I've made a stab at a minor improvement of the current docs, adding a 'name' parameter to the current 'Parser hook' template which sets the 'Has name' property: http://semantic-mediawiki.org/wiki/Category:Parser_hooks HTH, Dan. > Van. > > > ------------------------------------------------------------------------------ > RSA(R) Conference 2012 > Save $700 by Nov 18 > Register now > http://p.sf.net/sfu/rsa-sfdev2dev1 > _______________________________________________ > Semediawiki-user mailing list > Sem...@li... > https://lists.sourceforge.net/lists/listinfo/semediawiki-user > |
From: Van de B. <van...@gm...> - 2011-11-04 19:54:48
|
On Thu, 2011-11-03 at 20:18 +0000, Jeroen De Dauw wrote: > Hey, > > Not sure renaming the pages is the best approach. Why not just add > another field to the template for the actual parser hook name, and > display it in the table? My topic is that "Parser hook" is already is in the table, but it does not state parser hook name, but just an alternative version of "Description", sometimes just the same. Look into existing table: Adding tooltips -> Add an icon with tooltip Argument declaration in templates -> Argument declaration in templates Recurring events -> Silently set recurring semantic data in wiki page Setting values -> Silently set semantic data in wiki page What the meaning in such a duplication? > You can of course also redirect Help:parserhookname to it's current > equivalent for extra navigation convenience. Redirects already are in place, but it does not help, because redirection pages are not present in categories. > Either way, if you see a way to make it better - go for it - it's a > wiki after all :) Yes, but my vision of the "better" may not match the vision of SMW maintainers. > Cheers > > -- > Jeroen De Dauw > http://www.bn2vs.com > Don't panic. Don't be evil. > -- |
From: Dan B. <dan...@gm...> - 2011-11-04 21:10:51
|
On 4 November 2011 19:54, Van de Bugger <van...@gm...> wrote: > On Thu, 2011-11-03 at 20:18 +0000, Jeroen De Dauw wrote: >> Hey, >> >> Not sure renaming the pages is the best approach. Why not just add >> another field to the template for the actual parser hook name, and >> display it in the table? > > My topic is that "Parser hook" is already is in the table, but it does > not state parser hook name, but just an alternative version of > "Description", sometimes just the same. Look into existing table: > > Adding tooltips -> Add an icon with tooltip > Argument declaration in templates -> Argument declaration in templates > Recurring events -> Silently set recurring semantic data in wiki page > Setting values -> Silently set semantic data in wiki page > > What the meaning in such a duplication? > >> You can of course also redirect Help:parserhookname to it's current >> equivalent for extra navigation convenience. > > Redirects already are in place, but it does not help, because > redirection pages are not present in categories. > >> Either way, if you see a way to make it better - go for it - it's a >> wiki after all :) > > Yes, but my vision of the "better" may not match the vision of SMW > maintainers. There is only one way to find out ;-) I'd say, be bold, but be considerate. 1) try not to make the docs more confusing than they already are 2) try not to trash the work of others without giving consideration on how to integrate that work 3) do it the way you see best Good luck! Dan. >> Cheers >> >> -- >> Jeroen De Dauw >> http://www.bn2vs.com >> Don't panic. Don't be evil. >> -- > > > > ------------------------------------------------------------------------------ > RSA(R) Conference 2012 > Save $700 by Nov 18 > Register now > http://p.sf.net/sfu/rsa-sfdev2dev1 > _______________________________________________ > Semediawiki-user mailing list > Sem...@li... > https://lists.sourceforge.net/lists/listinfo/semediawiki-user > |
From: kghbln <med...@kg...> - 2011-11-04 21:35:15
|
Heiya, Yesterday I was wondering what caused Dan to suddenly put effort into the documentation pages for parser hooks. Now I see these posts. :) I agree that some effort has to be put into this and I am happy that Dan set a path to do it. As a matter of fact a fortnight ago I already put the pages there I would like to document all the parser hooks in English as well as German onto my watchlist (remember, remember ... :) . I think the approach should be similar to that used for the result formats: One general help page like Help:Result_formats [1] which is pointing to all the available result formats available. The category Parser hooks it just the bonus. This still may take some time since I do the German translations too. Cheers [[kgh]] [1] http://semantic-mediawiki.org/wiki/Help:Result_formats Am 04.11.2011 22:10, schrieb Dan Bolser: > On 4 November 2011 19:54, Van de Bugger<van...@gm...> wrote: >> On Thu, 2011-11-03 at 20:18 +0000, Jeroen De Dauw wrote: >>> Hey, >>> >>> Not sure renaming the pages is the best approach. Why not just add >>> another field to the template for the actual parser hook name, and >>> display it in the table? >> My topic is that "Parser hook" is already is in the table, but it does >> not state parser hook name, but just an alternative version of >> "Description", sometimes just the same. Look into existing table: >> >> Adding tooltips -> Add an icon with tooltip >> Argument declaration in templates -> Argument declaration in templates >> Recurring events -> Silently set recurring semantic data in wiki page >> Setting values -> Silently set semantic data in wiki page >> >> What the meaning in such a duplication? >> >>> You can of course also redirect Help:parserhookname to it's current >>> equivalent for extra navigation convenience. >> Redirects already are in place, but it does not help, because >> redirection pages are not present in categories. >> >>> Either way, if you see a way to make it better - go for it - it's a >>> wiki after all :) >> Yes, but my vision of the "better" may not match the vision of SMW >> maintainers. > There is only one way to find out ;-) > > I'd say, be bold, but be considerate. > > 1) try not to make the docs more confusing than they already are > 2) try not to trash the work of others without giving consideration on > how to integrate that work > 3) do it the way you see best > > > Good luck! > Dan. > >>> Cheers >>> >>> -- >>> Jeroen De Dauw >>> http://www.bn2vs.com >>> Don't panic. Don't be evil. >>> -- >> >> >> ------------------------------------------------------------------------------ >> RSA(R) Conference 2012 >> Save $700 by Nov 18 >> Register now >> http://p.sf.net/sfu/rsa-sfdev2dev1 >> _______________________________________________ >> Semediawiki-user mailing list >> Sem...@li... >> https://lists.sourceforge.net/lists/listinfo/semediawiki-user >> > ------------------------------------------------------------------------------ > RSA(R) Conference 2012 > Save $700 by Nov 18 > Register now > http://p.sf.net/sfu/rsa-sfdev2dev1 > _______________________________________________ > Semediawiki-user mailing list > Sem...@li... > https://lists.sourceforge.net/lists/listinfo/semediawiki-user > |
From: kghbln <med...@kg...> - 2011-11-04 22:11:27
|
Heiya, for the time being I have categorised the redirects for them to be at least shown in Category:Parser hooks [1]. Just click and enjoy :) Chees [[kgh]] [1] http://semantic-mediawiki.org/wiki/Category:Parser_hooks Am 04.11.2011 22:35, schrieb kghbln: > Heiya, > > Yesterday I was wondering what caused Dan to suddenly put effort into the documentation pages for parser > hooks. Now I see these posts. :) > > I agree that some effort has to be put into this and I am happy that Dan set a path to do it. As a matter of > fact a fortnight ago I already put the pages there I would like to document all the parser hooks in English as > well as German onto my watchlist (remember, remember ... :) . I think the approach should be similar to that > used for the result formats: One general help page like Help:Result_formats [1] which is pointing to all the > available result formats available. The category Parser hooks it just the bonus. > > This still may take some time since I do the German translations too. > > Cheers [[kgh]] > > [1] http://semantic-mediawiki.org/wiki/Help:Result_formats > > Am 04.11.2011 22:10, schrieb Dan Bolser: >> On 4 November 2011 19:54, Van de Bugger<van...@gm...> wrote: >>> On Thu, 2011-11-03 at 20:18 +0000, Jeroen De Dauw wrote: >>>> Hey, >>>> >>>> Not sure renaming the pages is the best approach. Why not just add >>>> another field to the template for the actual parser hook name, and >>>> display it in the table? >>> My topic is that "Parser hook" is already is in the table, but it does >>> not state parser hook name, but just an alternative version of >>> "Description", sometimes just the same. Look into existing table: >>> >>> Adding tooltips -> Add an icon with tooltip >>> Argument declaration in templates -> Argument declaration in templates >>> Recurring events -> Silently set recurring semantic data in wiki page >>> Setting values -> Silently set semantic data in wiki page >>> >>> What the meaning in such a duplication? >>> >>>> You can of course also redirect Help:parserhookname to it's current >>>> equivalent for extra navigation convenience. >>> Redirects already are in place, but it does not help, because >>> redirection pages are not present in categories. >>> >>>> Either way, if you see a way to make it better - go for it - it's a >>>> wiki after all :) >>> Yes, but my vision of the "better" may not match the vision of SMW >>> maintainers. >> There is only one way to find out ;-) >> >> I'd say, be bold, but be considerate. >> >> 1) try not to make the docs more confusing than they already are >> 2) try not to trash the work of others without giving consideration on >> how to integrate that work >> 3) do it the way you see best >> >> >> Good luck! >> Dan. >> >>>> Cheers >>>> >>>> -- >>>> Jeroen De Dauw >>>> http://www.bn2vs.com >>>> Don't panic. Don't be evil. >>>> -- >>> >>> ------------------------------------------------------------------------------ >>> RSA(R) Conference 2012 >>> Save $700 by Nov 18 >>> Register now >>> http://p.sf.net/sfu/rsa-sfdev2dev1 >>> _______________________________________________ >>> Semediawiki-user mailing list >>> Sem...@li... >>> https://lists.sourceforge.net/lists/listinfo/semediawiki-user >>> >> ------------------------------------------------------------------------------ >> RSA(R) Conference 2012 >> Save $700 by Nov 18 >> Register now >> http://p.sf.net/sfu/rsa-sfdev2dev1 >> _______________________________________________ >> Semediawiki-user mailing list >> Sem...@li... >> https://lists.sourceforge.net/lists/listinfo/semediawiki-user >> > ------------------------------------------------------------------------------ > RSA(R) Conference 2012 > Save $700 by Nov 18 > Register now > http://p.sf.net/sfu/rsa-sfdev2dev1 > _______________________________________________ > Semediawiki-user mailing list > Sem...@li... > https://lists.sourceforge.net/lists/listinfo/semediawiki-user > |