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

  • From: Noelia <nrm1977@xxxxxxxxx>
  • To: nvda-addons@xxxxxxxxxxxxx
  • Date: Mon, 14 Jul 2014 11:37:52 +0200

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

Other related posts: