[nvda-addons] Re: Possible addon to review: eMule app module
- From: Mesar Hameed <mesar.hameed@xxxxxxxxx>
- To: nvda-addons@xxxxxxxxxxxxx
- Date: Mon, 20 May 2013 16:23:59 +0200
Whatever you think is best/least change for existing addons.
What I am thinking of is like this:
0. addon author uses template.
1. addon author writes readme.mdown
2. [easy] we make available the readme.mdown in translators svn.
3. [done] system will automatically make po files from mdown file.
4. [done] translator translates the po file to his language.
5. [done] system converts po files to html.
6. Before making a release of this addon, we copy html files to doc
folder.
7. User installs addon and can use addon+read documentation in his
language.
This way, translator only has to translate text once, and it will be for
the website and directly included documentation at the same time for the
next release.
If the user has an old version of the addon, they can see the
documentation for his/her addon directly from inside nvda.
What do you think? Any way to make it more streamlined?
thanks,
Mesar
On Mon 20/05/13,16:02, Noelia wrote:
> I can create a doc folder and an en doc subdirectory. Can also write a
> docHandler.py file into addon template. So, if someone wish to put
> documentation into an addon, could copy and import docHandler to a
> globalPlugin or appModule folder and use docHandler.getDocPath
> function, for opening or reading the corresponding readme.txt or html
> file.
> If you have other suggestion, let me know.
>
> 2013/5/20, Mesar Hameed <mesar.hameed@xxxxxxxxx>:
> > Hi Nolia,
> > Being able to bundle and read addon documentation is important.
> > Until 2694 is resolved, do you think you can apply the same
> > modifications that you already have for emule to addonTemplate?
> >
> > thanks,
> > Mesar
> > On Mon 13/05/13,23:19, Noelia wrote:
> >> OK.
> >> But addons like eMule and placeMarkers include into the source code a
> >> way for open documentation in the selected language or English by
> >> default, as proposed on the corresponding ticket. I use the same code
> >> that I send to this ticket as a patch, acording with suggestions sent
> >> by other people to this ticket too.
> >> Thanks.
> >>
> >> 2013/5/13, Mesar Hameed <mesar.hameed@xxxxxxxxx>:
> >> > Hi Noelia,
> >> > I think at the moment nvda doesnt have a way to display addon
> >> > documentation, although we have a ticket for this.
> >> >
> >> > if you can provide me with the english text file when it is ready we
> >> > can
> >> > take it from there. The folders is not important at this stage.
> >> >
> >> > This reminds me that I need to write some more documentation on how the
> >> > system works to explain
> >> > all things that at first feel a little strange.
> >> >
> >> > Thanks,
> >> > On Mon 13/05/13,23:02, Noelia wrote:
> >> >> Hi Mesar, the other author of this add-on is translating the HTML file
> >> >> into English.
> >> >> We put these files into doc folder, that contains directories named as
> >> >> language code, for instance es, en, etc.
> >> >> We create HTML files. If should build markdown files for your system,
> >> >> let me know.
> >> >> Thanks.
> >> >>
> >> >> 2013/5/13, Mesar Hameed <mesar.hameed@xxxxxxxxx>:
> >> >> > Noelia, do you think you can translate the readme.html to english?
> >> >> > We just need a text file, the system will make po files for
> >> >> > translators
> >> >> > from the readme, and convert the markdown to html automatically.
> >> >> >
> >> >> > Thanks,
> >> >> > Mesar
> >> >> > On Mon 13/05/13,19:19, Noelia wrote:
> >> >> >> I have commited translators comments for eMule:
> >> >> >> https://bitbucket.org/nvdaaddonteam/emule
> >> >> >> Thanks.
> >> >> >>
> >> >> >> 2013/5/13, Noelia <nrm1977@xxxxxxxxx>:
> >> >> >> > OK, thank you. Regards.
> >> >> >> >
> >> >> >> > 2013/5/13, Mesar Hameed <mesar.hameed@xxxxxxxxx>:
> >> >> >> >> ok, I have renamed it on bitbucket, now any checked out copy
> >> >> >> >> need
> >> >> >> >> to
> >> >> >> >> change the url.
> >> >> >> >>
> >> >> >> >> edit .git/config
> >> >> >> >>
> >> >> >> >> Depending if you are using ssh or https, you will see something
> >> >> >> >> like:
> >> >> >> >> url = https://bitbucket.org/nvdaaddonteam/emuleappmodule
> >> >> >> >> or
> >> >> >> >> url = git@xxxxxxxxxxxxx:nvdaaddonteam/emuleappmodule.git
> >> >> >> >>
> >> >> >> >> just delete appmodule, save/exit.
> >> >> >> >>
> >> >> >> >> now if we do git pull, or push, it should work correctly, say
> >> >> >> >> everything
> >> >> >> >> is up to date.
> >> >> >> >> if there is an error then the url is not quite right.
> >> >> >> >>
> >> >> >> >> To rename a repository on bitbucket, go to the git repo, click
> >> >> >> >> on
> >> >> >> >> admin,
> >> >> >> >> change repository details -> and edit the name edit field.
> >> >> >> >> I am not sure if it is visible to everyone or just the
> >> >> >> >> owner/superowner.
> >> >> >> >>
> >> >> >> >> Thanks in any case :)
> >> >> >> >> Mesar
> >> >> >> >> On Mon 13/05/13,13:28, Noelia wrote:
> >> >> >> >>> OK, thank you. I`f you can, please tell me how to rename the
> >> >> >> >>> repo.
> >> >> >> >>> I
> >> >> >> >>> am new in using Git. Thanks for your help and good ideas.
> >> >> >> >>>
> >> >> >> >>> 2013/5/13, Mesar Hameed <mesar.hameed@xxxxxxxxx>:
> >> >> >> >>> > Hi Noelia,
> >> >> >> >>> >
> >> >> >> >>> > If the repository name on bitbucket is the same name as the
> >> >> >> >>> > addon
> >> >> >> >>> > it
> >> >> >> >>> > becomes easier for the automated system, when looking for
> >> >> >> >>> > translations.
> >> >> >> >>> >
> >> >> >> >>> > re translation comments, it is best to put comments, and when
> >> >> >> >>> > review
> >> >> >> >>> > process is over and people feel addon is stable, we make it
> >> >> >> >>> > available
> >> >> >> >>> > for all language translators, if he/she feels
> >> >> >> >>> > that the addon is useful for their community and have time to
> >> >> >> >>> > translate
> >> >> >> >>> > it, they will add the translation.
> >> >> >> >>> >
> >> >> >> >>> > At least as addon authors we did what we need to do, and its
> >> >> >> >>> > up
> >> >> >> >>> > to
> >> >> >> >>> > each
> >> >> >> >>> > translator to do their contribution.
> >> >> >> >>> >
> >> >> >> >>> > Thanks,
> >> >> >> >>> > Mesar
> >> >> >> >>> > On Mon 13/05/13,10:13, Noelia wrote:
> >> >> >> >>> >> Hi Mesar, the addon name is just eMule, though repo's
> >> >> >> >>> >> includes
> >> >> >> >>> >> app
> >> >> >> >>> >> module.
> >> >> >> >>> >> Anyway, a previous version of this addon is available in web
> >> >> >> >>> >> sites
> >> >> >> >>> >> named eMuleNVDASupport.
> >> >> >> >>> >> This version does not contain translators comments as I
> >> >> >> >>> >> don't
> >> >> >> >>> >> know
> >> >> >> >>> >> if
> >> >> >> >>> >> it will be translated.
> >> >> >> >>> >> Thanks.
> >> >> >> >>> >>
> >> >> >> >>> >> 2013/5/13, Mesar Hameed <mesar.hameed@xxxxxxxxx>:
> >> >> >> >>> >> > Hi all,
> >> >> >> >>> >> >
> >> >> >> >>> >> > How do people feel about setting up the bitbucket email
> >> >> >> >>> >> > notifications/diff to come to the mailing list?
> >> >> >> >>> >> > This will mean we dont have to maintain a list of
> >> >> >> >>> >> > interested
> >> >> >> >>> >> > people
> >> >> >> >>> >> > for
> >> >> >> >>> >> > each addon.
> >> >> >> >>> >> > Idealy we would have something like
> >> >> >> >>> >> > nvda-commits@xxxxxxxxxxxxxxxxxx,
> >> >> >> >>> >> > but
> >> >> >> >>> >> > I don't think its quite appropriate to send addon commit
> >> >> >> >>> >> > emails
> >> >> >> >>> >> > there,
> >> >> >> >>> >> > and/or if we want to maintain another list.
> >> >> >> >>> >> > Thoughts?
> >> >> >> >>> >> >
> >> >> >> >>> >> > Mesar
> >> >> >> >>> >> > ----------------------------------------------------------------
> >> >> >> >>> >> >
> >> >> >> >>> >> > 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.
> >> >> >> >>> >> >
> >> >> >> >>> >> >
> >> >> >> >>> >> ----------------------------------------------------------------
> >> >> >> >>> >>
> >> >> >> >>> >> 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.
> >> >> >> >>> >>
> >> >> >> >>> > ----------------------------------------------------------------
> >> >> >> >>> >
> >> >> >> >>> > 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.
> >> >> >> >>> >
> >> >> >> >>> >
> >> >> >> >>> ----------------------------------------------------------------
> >> >> >> >>>
> >> >> >> >>> 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.
> >> >> >> >>>
> >> >> >> >> ----------------------------------------------------------------
> >> >> >> >>
> >> >> >> >> 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.
> >> >> >> >>
> >> >> >> >>
> >> >> >> >
> >> >> >> ----------------------------------------------------------------
> >> >> >>
> >> >> >> 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.
> >> >> >>
> >> >> > ----------------------------------------------------------------
> >> >> >
> >> >> > 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.
> >> >> >
> >> >> >
> >> >> ----------------------------------------------------------------
> >> >>
> >> >> 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.
> >> >>
> >> > ----------------------------------------------------------------
> >> >
> >> > 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.
> >> >
> >> >
> >> ----------------------------------------------------------------
> >>
> >> 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.
> >>
> > ----------------------------------------------------------------
> >
> > 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.
> >
> >
> ----------------------------------------------------------------
>
> 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.
>
----------------------------------------------------------------
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.
Other related posts:
