[nvda-addons] Re: RFC: don't use the repository README as add-on user documentation (was) Re: Re: Configobj requirement in addon template

  • From: Rui Batista <ruiandrebatista@xxxxxxxxx>
  • To: nvda-addons@xxxxxxxxxxxxx
  • Date: Thu, 4 Sep 2014 01:01:14 +0100

Hi Mesar

For some reason, I never got your original message, so… didn’t reply :). Hope 
you are doing well.

Regarding your questions:

> 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.

Yes. Actually I wanted to merge feature/tools into next but didn’t do it, don’t 
recall exactly why.



>> 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.

Sure. Probably feature/tools should readily replace next and merge into master 
as soon as 2014.3 roles out.


>> 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.


Agree.


>> 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?

Sure. In the tools code (e.g gettext) I’m using scons’’s variable interpolation 
which very much simplifies the code and makes it much more readable (IMO 
ofcourse). However, as dash is a Python operator it would make that very hard 
or probably impossible so that was the cleanest solution. It’s also useful if 
we wanted to use add-on variables on templates and such.


>> 
>> 
>> The feature/betterMarkdown branch, were you thinking we would have a new 
>> command with its template to produce ikiwiki ready
>> files?
>> 
Probably. It would also be nce for converting docs to PDF or other formats, so 
the Jinja2 pre-processing. However the workflow is kind of complex and I’m not 
very happy with it… Consider that a prototype or draft or something :).

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

Other related posts: