What the list thinks about this concepts: * The benefits of have centralized data on the help. * If it is like a relational database then would be possible to store more than one example for each case. * Should be store also who contributed with that example and when. * Is important that the work of a friend be acknowledge. * That information should be elegantly showed on offline help and also online help. * Make easy and secure that kind of contribution. * Easy is about to click a button (or a link inside the help), login the account, and send the data. * The noise that could be generated, to prevent that the login is something that helps. * Take care of the elegancy of the environment and none of it could be ugly.
Em 20/02/2012, às 22:02, Everton Vieira escreveu: > > Em 20/02/2012, às 21:15, Everton Vieira escreveu: > >> >> Em 20/02/2012, às 21:02, Everton Vieira escreveu: >> >>> >>> Em 20/02/2012, às 19:46, waldo kitty escreveu: >>> >>>> On 2/20/2012 10:59, Everton Vieira wrote: >>>>> Has been felt need for examples in the documentation. >>>> >>>> i haven't yet gotten to this stage of my stack of "round to its" (joke >>>> "getting around to it") and this seems ok time... not only are examples >>>> needed but also sample output... i have been digging in the help, as many >>>> know, trying to get back my "coding legs" and have found examples that >>>> didn't have any output so that one could see what the result would be with >>>> certain input... i've also seen examples that said something to the effect >>>> of "see this example over here" which took you to another help item that >>>> did actually have some example code that may or may not contain the topic >>>> you were looking at before... and again, there is the need for sample >>>> output from sample input... >>>> >>>> not only should these examples be in/on the wiki, but they should also be >>>> in the offline local documentation... >>> >>> Some parts of the wiki could be generated by the same database that could >>> also generate the offline help. I`m not well aware of the development of >>> the help system but i bet some is been done in this way. After all, is far >>> well know the benefits of have centralized data. And i`m not aware how the >>> help data are been stored, but if it is like a relational database then >>> would be possible to store more than one example for each case, and more, >>> should be store also who contributed with that example and when. Is >>> important that the work of a friend be acknowledge. And that information >>> should be elegantly showed on offline help and also online. >> >> Now, to make easy and secure that kind of contribution, i bet is a challenge. > > Easy is about to click a button (or a link inside the help), login the > account, and send the data. > > And of course theres the noise that could be generated, but to prevent that > is also about to make the means secured, and the login is something that > helps in that. > > And of course we should concern about the elegancy of the environment and > none of this could be ugly. > >> >>> >>>> offline local documentation being the most important (IMhO)... >>>> >>>> -- >>>> _______________________________________________ >>>> Lazarus mailing list >>>> [email protected] >>>> http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus >>> >> > -- _______________________________________________ Lazarus mailing list [email protected] http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus
