[nvda-addons] Re: Possible addon to review: eMule app module
- From: Noelia <nrm1977@xxxxxxxxx>
- To: nvda-addons@xxxxxxxxxxxxx
- Date: Mon, 20 May 2013 19:20:47 +0200
Sorry: I want to say markdown, not addon.
Talking about docHandler, I think it's ready to be tested.
I will send it.
To use this module you can:
0. Create directories contained in doc folder, whose names are the
corresponding code of a specific language, for instance es, it or ar.
Copy the translated HTML file in the corresponding doc/lang doc
folder.
1. Copy the file docHandler.py to a globalPlugin or appModule folder.
2. Import the module like this:
import docHandler.
3. If you want open the addon documentation in the apropiate language
if available, or in English by default, in a script or a function
associated with an event, call openDocPath() function:
docHandler.openDocPath()
You can change the addon directory (addonDir parameter of getDocFolder
function) or the name of the files that contain documentation.
By default addonDir is os.path.dirname(__file__)/.., and
docFileName="readme.html".
Thanks.
2013/5/20, Noelia <nrm1977@xxxxxxxxx>:
> Hi Chris:
> Here is addon template addon. I hope it can be useful:
>
> # NVDA Add-on Scons Template
>
> This package contains a basic template structure for NVDA add-on
> development, building, distribution and localization.
> For details about NVDA add-on development please see the [NVDA
> Developer
> Guide](http://www.nvda-project.org/documentation/developerGuide.html).
>
> Copyright (C) 2012 - Rui Batista.
>
> This package is distributed under the terms of the GNU General Public
> License, version 2 or later. Please see the file COPYING.txt for
> further details.
>
> ## Features
>
> This template provides the following features you can use to help NVDA
> add-on development:
> * Automatic add-on package creation, with naming and version loaded
> from a centralized build variables file (buildVars.py).
> * Manifest file creation using a template (manifest.ini.tpl). Build
> variables are replaced on this template.
> * Compilation of gettext mo files before distribution, when needed.
> - To generate a gettext pot file, please run scons pot. a
> <adon-name>.pot file will be created with all gettext messages for
> your add-on. You need to check the buildVars.i18nSources variable to
> comply with your requirements.
> * Automatic generation of manifest localization files directly from
> gettext po files. Please make sure buildVar.py is included in
> i18nFiles.
>
> ## Requirements
>
> You need the following software to use this code for your NVDA add-ons
> development:
>
> - a Python distribution (2.7 or greater is recommended). Check the
> [Python Website](http://www.python.org) for Windows Installers.
> - Scons - [Website](http://www.scons.org/) - version 2.1.0 or greater.
> Install it using **easy_install** or grab an windows installer from
> the website.
> - GNU Gettext tools, if you want to have localization support on your
> add-on - Recommended. Any Linux distro or cygwin have those installed.
> You can find windows builds
> [here](http://gnuwin32.sourceforge.net/downlinks/gettext.php).
>
> ## Usage
>
> To create a new NVDA add-on, taking advantage of this template:
>
> - Create an empty folder to hold the files for your add-on.
> - Copy the **addon** folder, the **buildVars.py** file, the
> manifest.ini.tpl file, the manifest-translated.ini.tpl,
> **SCONSTRUCT**, .gitignore and .gitattributes files to the created
> folder
> - In the **buildVars.py** file, change variable **addon_info** with
> your add-on's information (name, summary, description, version, author
> and url).
> - Put your code in the usual folders for NVDA extension, under the
> **addon** folder. For instance: globalPlugins, synthDrivers, etc. You
> can delete folders you don't need for your particular add-on package.
> - Gettext translations must be placed into
> addon\locale\<lang>/LC_MESSAGES\nvda.po.
> - To package the add-on for distribution, open a command line, change
> to the folder that has the **SCONSTRUCT** file and run the **scons**
> command. The created add-on, if there were no errors, is placed in the
> current directory.
> - You can further customize variables in the **buildVars.py** file.
>
> Note that this template only provides a basic add-on structure and
> build infrastructure. You may need to adapt it for your specific
> needs.
>
>
> ## Author Information
>
> If you have any issues or whatever, please use github, bitbucket, the
> NVDA development list, or just drop me an email to ruiandrebatista at
> gmail dot com.
>
>
> 2013/5/20, Ch-L <llajta@xxxxxx>:
>> Hi Noelia and Mesar,
>> I do not work much with markdown documents, I hope this goes fine;
>> http://bit.ly/10gpiLG -.
>> Any revision is apreciated!
>> If you can show me a markdown document as an example, so I see that
>> syntax you're using more.
>>
>> I left the html tags for description of additional commands for reading
>> lists in eMule:
>> If it's a problems replace the table tags with the following list:
>> ---
>> * nvda+control+1-0: Allows to Read the first 10 columns.
>> * nvda+shift+1-0: Allows to read the correspondent column, from 11th to
>> 20th.
>> * nvda+shift+C: Copies to clipboard the contents of the last column read.
>> ---
>>
>> VeryThanks.
>>
>> Chris()
>>
>> Mesar Hameed wrote:
>> " Hi Chris,
>>
>> ...I still want a copy in markdown format..."
>> ----------------------------------------------------------------
>>
>> 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:
