Hi Joseph, all, Replying in this thread, so that the conversation is all linked together. I didn't get a reply from anyone with regard to the comments in the email below. I would value if someone else could spend some time re-reading the various implementations and give a second opinion before we start merging things. thanks, Mesar On Fri 18/07/14,12:07, Mesar Hameed wrote: > Hi Rui, > > If I have read the code correctly, the modifications in features/tools looks > good, and are cleaner than the > t2694, t2694-2 and next branches. > I suggest deleting these three, and wait until 2014.3 is out, after > which we can merge/role out the updated template for the addons. > Updating/releasing the addons is not a fast process, so the more we can > agree on and implement the better, so that we don't have to iterate over > too many template updates. > question: in buildvars.py, you seem to have renamed some fields that > were with dash to underscore, addon-name addon_name this was not done in the > three branches > above, was this intentional/what was the idea behind this? > > > The feature/betterMarkdown branch, were you thinking we would have a new > command with its template to produce ikiwiki ready > files? > > Mesar > On Mon 14/07/14,12:07, Rui Batista wrote: > > Hi, > > > > What we have on the addontemplate next branch is compatible with current > > add-ons. What breaks compatibility is my feature/betterMarkdown branch > > which is a work in progress, and tries to put in practice my own ideas > > about documentation, not something that I want to impose or something else. > > > > Regards, > > > > Rui Batista > > No dia 14/07/2014, às 10:42, Joseph Lee <joseph.lee22590@xxxxxxxxx> > > escreveu: > > > > > Hi, > > > Does Bitbucket accept t2t syntax for readme? When someone views an entry > > > for > > > an add-on from Bitbucket site, readme.md is displayed, which currently is > > > the help file for the add-on. A better way would have been to use wiki > > > facility in Bitbucket or webpage facility in Github (for some), with the > > > wiki providing a link to the help file that is the current readme.md for > > > majority of the add-ons (by the way, majority of the add-ons hasn't been > > > updated in a while, which might be a bit of a problem if we go ahead and > > > use > > > restructured add-on template). > > > Cheers, > > > Joseph > > > > > > -----Original Message----- > > > From: nvda-addons-bounce@xxxxxxxxxxxxx > > > [mailto:nvda-addons-bounce@xxxxxxxxxxxxx] On Behalf Of Noelia > > > Sent: Monday, July 14, 2014 2:38 AM > > > To: nvda-addons@xxxxxxxxxxxxx > > > Subject: [nvda-addons] Re: RFC: don't use the repository README as add-on > > > user documentation (was) Re: Re: Configobj requirement in addon template > > > > > > I agree totally in this point with you. I started using Markdown here just > > > because I found tools easily, to build HTML and validate, even on line. > > > Thanks. > > > > > > 2014-07-14 11:31 GMT+02:00, Rui Batista <ruiandrebatista@xxxxxxxxx>: > > >> Hi, > > >> > > >> I don't mind integrating t2t support also, but (this is a personal > > >> opinion) markdown is a bit easier and we have more tools at our > > >> disposal, not just for composing but for parsing, transforming, etc. > > >> > > >> I don't know how Jamie and Mike feel about this, but I'd say if NVDA > > >> core documentation was started today, markdown would be probably a > > >> better choice. > > >> > > >> In the end both work fine :). > > >> > > >> Regards, > > >> > > >> Rui Batista > > >> No dia 14/07/2014, às 01:05, Him Prasad Gautam > > >> <drishtibachak@xxxxxxxxx> > > >> escreveu: > > >> > > >>> Hi, > > >>> What about the t2t format. Translators are already familiar to it in > > >>> main nvda translation. I do not see any extra benefits adopting > > >>> markdown . > > >>> > > >>> > > >>> On 7/14/14, Rui Batista <ruiandrebatista@xxxxxxxxx> wrote: > > >>>> Hi, > > >>>> No dia 13/07/2014, às 19:03, Noelia <nrm1977@xxxxxxxxx> escreveu: > > >>>> > > >>>>> Imo the system developed by Mesars uses gettext files for > > >>>>> documentation, but the conversion to HTML is based on markdown, and > > >>>>> md files are converted to GetText files, so they are the main > > >>>>> source. > > >>>> > > >>>> I disagree. Only english markdown file is the main source. Others > > >>>> are generated from gettext output. > > >>>> > > >>>> [...] > > >>>> > > >>>> > > >>>>> Furthermore, readme files explain what you call user documentation, > > >>>>> and for me it's right. > > >>>> > > >>>> It's right they explain user documentation. But now english one is > > >>>> also used for repository (development) documentation, so the special > > >>>> case in the build infra-structure. > > >>>> > > >>>> Regards, > > >>>> > > >>>> Rui > > >>>> Batista------------------------------------------------------------- > > >>>> --- > > >>>> > > >>>> NVDA add-ons Central: A list for discussing NVDA add-ons > > >>>> > > >>>> To post a message, send an email to nvda-addons@xxxxxxxxxxxxx. > > >>>> > > >>>> To unsubscribe, send an email with the subject line of "unsubscribe" > > >>>> (without quotes) to nvda-addons-request@xxxxxxxxxxxxx. > > >>>> > > >>>> If you have questions for list moderators, please send a message to > > >>>> nvda-addons-moderators@xxxxxxxxxxxxx. > > >>>> > > >>>> Community addons can be found here: http://addons.nvda-project.org > > >>>> > > >>> > > >>> > > >>> -- > > >>> Him Prasad Gautam > > >>> Kathmandu, Nepal > > >>> ---------------------------------------------------------------- > > >>> > > >>> NVDA add-ons Central: A list for discussing NVDA add-ons > > >>> > > >>> To post a message, send an email to nvda-addons@xxxxxxxxxxxxx. > > >>> > > >>> To unsubscribe, send an email with the subject line of "unsubscribe" > > >>> (without quotes) to nvda-addons-request@xxxxxxxxxxxxx. > > >>> > > >>> If you have questions for list moderators, please send a message to > > >>> nvda-addons-moderators@xxxxxxxxxxxxx. > > >>> > > >>> Community addons can be found here: http://addons.nvda-project.org > > >> > > >> ---------------------------------------------------------------- > > >> > > >> NVDA add-ons Central: A list for discussing NVDA add-ons > > >> > > >> To post a message, send an email to nvda-addons@xxxxxxxxxxxxx. > > >> > > >> To unsubscribe, send an email with the subject line of "unsubscribe" > > >> (without quotes) to nvda-addons-request@xxxxxxxxxxxxx. > > >> > > >> If you have questions for list moderators, please send a message to > > >> nvda-addons-moderators@xxxxxxxxxxxxx. > > >> > > >> Community addons can be found here: http://addons.nvda-project.org > > >> > > > ---------------------------------------------------------------- > > > > > > NVDA add-ons Central: A list for discussing NVDA add-ons > > > > > > To post a message, send an email to nvda-addons@xxxxxxxxxxxxx. > > > > > > To unsubscribe, send an email with the subject line of "unsubscribe" > > > (without quotes) to nvda-addons-request@xxxxxxxxxxxxx. > > > > > > If you have questions for list moderators, please send a message to > > > nvda-addons-moderators@xxxxxxxxxxxxx. > > > > > > Community addons can be found here: http://addons.nvda-project.org > > > > > > ---------------------------------------------------------------- > > > > > > NVDA add-ons Central: A list for discussing NVDA add-ons > > > > > > To post a message, send an email to nvda-addons@xxxxxxxxxxxxx. > > > > > > To unsubscribe, send an email with the subject line of "unsubscribe" > > > (without quotes) to nvda-addons-request@xxxxxxxxxxxxx. > > > > > > If you have questions for list moderators, please send a message to > > > nvda-addons-moderators@xxxxxxxxxxxxx. > > > > > > Community addons can be found here: http://addons.nvda-project.org > > > > ---------------------------------------------------------------- > > > > NVDA add-ons Central: A list for discussing NVDA add-ons > > > > To post a message, send an email to nvda-addons@xxxxxxxxxxxxx. > > > > To unsubscribe, send an email with the subject line of "unsubscribe" > > (without quotes) to nvda-addons-request@xxxxxxxxxxxxx. > > > > If you have questions for list moderators, please send a message to > > nvda-addons-moderators@xxxxxxxxxxxxx. > > > > Community addons can be found here: http://addons.nvda-project.org
Attachment:
signature.asc
Description: Digital signature
