---------- Forwarded message ---------- From: Joseph Lee <[email protected]> Date: Thu, 3 Sep 2015 23:31:47 -0700 Subject: [nvda-addons] Announcing NVDA Documentation Collection repository To: [email protected]
Hi all, I'm delighted to announce the launch of NVDA Documentation Collection repository. This repo was recycled from old NVDA Add-on Development Guide repo (that guide now lives in a new home) and can be found at: https://bitbucket.org/nvdaaddonteam/devGuide The repo home page has been redesigned to leave room for future community contributions (so far, the add-on dev guide and my internals article on Studio add-on are available; the one on SysTray List will be available after wikifying it). The home page also includes a letter from an add-on reviewer (me) explaining the purpose of this repo and how to contribute. To contribute your article or documentation: 1. If you have Git and have commit access to NVDA Add-ons Team repositories, clone the following two repos: git clone https://bitbucket.org/nvdaaddonteam/devGuide git clone https://bitbucket.org/nvdaaddonteam/devGuide/wiki The first repo is the home page (readme.md), and the second is the wiki where the pages will be stored. 2. When wikifying your documentation, use Markdown syntax (not Txt2Tags (T2T) syntax). 3. You need your Bitbucket credentials (user name and password) to commit changes. 4. When adding a new documentation into the wiki repo, use git add command. Push to the wiki repo first, then modify the main readme.md (first repo) to point to the wiki link then do a git push. 5. When adding a new documentation entry for an add-on, please write the following information: * Add-on author name. * Where to download the add-on and/or its source code * Link to the add-on wiki documentation in the wiki repo. If you don't have access to Git or don't have commit access: 1. Write your documentation using a text editor. Try using Markdown syntax. 2. Send your documentation as an attachment to this list or let us know the URL from where we can read your documentation (if you have a website; in case you've uploaded your docs to a service such as Dropbox or OneDrive, please let us know the URL to download your file). A few guidelines (you don't have to follow all of them and we'll leave room for exceptions): 1. If you are writing an add-on internals article (or a series of articles), please write your name (so that we can give you authorship credit) and the version of the add-on you are writing about. Don't forget to include copyright notices (for the add-on and any libraries it uses) and disclaimer (if you are writing about an add-on that isn't yours). 2. If you'll be documenting NVDA Core modules or functions, please base it from the latest official release or master branch at the time of your writing, and please give the full signature of the function you're writing about (example, if writing about message function in the UI module, please use ui.message; similarly , if documenting various UIA objects, please use NVDAObjects.UIA.ClassName e.g. NVDAObjects.UIA.Toast). Please remember that Mick and Jamie are the real experts of NVDA source code. 3. If your article references Windows API functions, please specify which DLL exposes this function (e.g. FindWindow is exposed by user32.dll). This is a must, as NVDA provides wrappers for various Windows API functions, housed in wrapper modules (for example, various wrappers for user32.dll functions live in winUser.py). 4. Please provide references at the end of articles (you don't have to, but it is encouraged). References may include links to MSDN entry for a particular Windows API function, documentation to third-party libraries mentioned and third-party resources. This helps readers learn more about how certain functions work, read more about libraries used and so on (to research them further). 5. Note that this is a draft version. Guidelines may change based on community feedback. Please let us know if you find some flaws with these and things that need changing. Thanks, and looking forward to your contributions. Cheers, Joseph -- Warm Regards Bhavya Shah Using NVDA (Non Visual Desktop Access) free and open source screen reader for Microsoft Windows To download a copy of the free screen reader NVDA, please visit http://www.nvaccess.org/ Using Google Talkback on Motorolla G second generation Lollipop 5.0.2 Reach me through the following means: Mobile: +91 7506221750 E-mail id: [email protected] Skype id : bhavya.09 Register at the dedicated AccessIndia list for discussing accessibility of mobile phones / Tabs on: http://mail.accessindia.org.in/mailman/listinfo/mobile.accessindia_accessindia.org.in Search for old postings at: http://www.mail-archive.com/[email protected]/ To unsubscribe send a message to [email protected] with the subject unsubscribe. To change your subscription to digest mode or make any other changes, please visit the list home page at http://accessindia.org.in/mailman/listinfo/accessindia_accessindia.org.in Disclaimer: 1. Contents of the mails, factual, or otherwise, reflect the thinking of the person sending the mail and AI in no way relates itself to its veracity; 2. AI cannot be held liable for any commission/omission based on the mails sent through this mailing list..
