[nvda-addons] Re: commit/addonTemplate: norrumar: Support for addons documentation: initial commit.
- From: Mesar Hameed <mesar.hameed@xxxxxxxxx>
- To: nvda-addons@xxxxxxxxxxxxx
- Date: Thu, 23 May 2013 11:18:50 +0200
It is probably safe to say that installTasks.py from addonTemplate
should always install the help to the help submenu.
If the addon needs anything else in the menues then the addon writer can
do that in his code. We can probably help him, but thats probably a
different task.
So what I am thinking is this:
* addon writer copies all of the template.
* he puts his addon in addon folder without any change to the code.
* creates readme and puts html in doc folder
* when he builds/installs automatically installTasks finds the addon
* name from buildvars and creates an item in the menu with the addon
* name.
If he needs options then he can extend the default installtasks or
whatever is needed.
Logical?
thanks,
Mesar
On Thu 23/05/13,11:06, Noelia wrote:
> OK Mesar and all. I know that in Ticket 2694, if I remember it well,
> somebody talks about appending documentation to help menu. I agree
> with you: people mostly talks about adding documentation to help, and
> settings to preferences. But I think that addons can add their own
> menus, integrated into NVDA's menu, to provide functions that don't
> required shortcut keys. This is useful because it allows not to waste
> too much keystrokes.
> Perhaps we can add documentation to help, settings under preferences
> and other functions to tools menu.
>
> 2013/5/23, Mesar Hameed <mesar.hameed@xxxxxxxxx>:
> > I think from previous discussions on the dev list, the general feeling
> > was as follows:
> >
> > 1. add any documentation under the help menu i.e. help -> Emule
> > help -> eMule should open the readme file as provided in
> > docs/lang/readme.html
> > 2. If an addon needs to add a menu option for its settings then it
> > should be straight into the normal menu wherever is most suitable, most
> > probably under preferences.
> > The reason behind this is so that addons feel like part of nvda instead
> > of finding them in a addon submenu.
> >
> > of course if the user installs a lot of addons then the menues will get
> > quite large, but I think this is the agreement at the moment.
> >
> > I can't find the dev list archive links for the threads where this
> > information is available, and it was in multiple threads if I am not too
> > mistaken.
> >
> > @joseph, jamie just confirmed on irc.
> >
> > Thanks.
> > Mesar
> > On Thu 23/05/13,07:48, Noelia wrote:
> >> I'm not sure about this point, because there are addons, as I pointed
> >> out in a previous message, that add its own menu, and other can add
> >> documentation to help.
> >> For instance I have different addons with documentation in the addon
> >> menu, under NVDA main menu. But the addon for PerkyDucks has
> >> documentation appended to help NVDA's menu, and place markers, in
> >> addon menu but under preferences. I don't know, but I can collaborate
> >> if you want.
> >>
> >> 2013/5/23, Mesar Hameed <mesar.hameed@xxxxxxxxx>:
> >> > Thanks Nolia,
> >> >
> >> > What do you think about making things more automatic and consistant,
> >> > for
> >> > example
> >> > automatically add documentation to nvda menu if we provide a default
> >> > installTasks.py file? That way end users know that documentation will
> >> > be in the menu after they install any addon.
> >> > we will be forced into a good habit of writing at least a minimal
> >> > readme.
> >> > If its done by installTasks the addon writer probably needs to do even
> >> > less in his code, thoughts?
> >> >
> >> > thanks,
> >> > Mesar
> >> > On Wed 22/05/13,23:10, Noelia wrote:
> >> >> Hello, I have tried to send a pull request for this new branch. You
> >> >> can accept it in case you think it's useful.
> >> >> Thanks.
> >> > ----------------------------------------------------------------
> >> >
> >> > 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.
> >
> > 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
Other related posts:
