[nvda-addons] commit/placeMarkers: norrumar: Added readme.md and new addon template with automatic documentation support.

From: commits-noreply@xxxxxxxxxxxxx
To: nvda-addons@xxxxxxxxxxxxx
Date: Fri, 31 May 2013 14:46:30 -0000
1 new commit in placeMarkers:

https://bitbucket.org/nvdaaddonteam/placemarkers/commits/ce5be7331ffc/
Changeset:   ce5be7331ffc
Branch:      master
User:        norrumar
Date:        2013-05-31 16:45:06
Summary:     Added readme.md and new addon template with automatic 
documentation support.

Affected #:  2 files

diff --git a/addon/doc/en/readme.html b/addon/doc/en/readme.html
index 23eef89..cf695d1 100755
--- a/addon/doc/en/readme.html
+++ b/addon/doc/en/readme.html
@@ -53,6 +53,7 @@ Using Place markers submenu, under Preferences menu, you can 
access to
 <li>Restore placeMarkers; you can restore your bookmarks  from a placeMarkers 
folder previously saved.</li><li>Documentation file, in your selected language 
if available, or English by default.</li></ul>
+<p>Note: The bookmark position is based on the number of characters; in pages 
with a dynamic content is better to use the specific  search and not the 
bookmarks to save a more precise position.</p></div><div id="footer"><p>Last 
revision: 05/05/2013, by</p>

diff --git a/sconstruct b/sconstruct
index 4366cca..e6a7a4a 100755
--- a/sconstruct
+++ b/sconstruct
@@ -5,6 +5,8 @@
 
 import codecs
 import gettext
+import shutil
+import os
 import os.path
 import zipfile
 import configobj
@@ -56,9 +58,27 @@ env['BUILDERS']['gettextMergePotFile']=env.Builder(
        ], lambda t, s, e : "Generating pot file %s" % t[0]),
        suffix=".pot")
 
+def createAddonHelp(dir):
+       docdir = os.path.join(dir, "doc", "en")
+       if not os.path.isdir(docdir):
+               return
+       docFilename = 
"{addonName}_docHandler.py".format(addonName=buildVars.addon_info["addon-name"])
+       plugindir = os.path.join(dir, "globalPlugins")
+       docPath = os.path.join(plugindir, docFilename)
+       if not os.path.isdir(plugindir):
+               os.makedirs(plugindir)
+       shutil.copy("docHandler.py", plugindir)
+       curdir = os.getcwd()
+       if os.path.isfile(docPath):
+               os.unlink(docPath)
+       os.chdir(plugindir)
+       os.rename("docHandler.py", docFilename)
+       os.chdir(curdir)
+
 def createAddonBundleFromPath(path, dest):
-       """ Creates a bundle from a directory that contains a a addon manifest 
file."""
+       """ Creates a bundle from a directory that contains an addon manifest 
file."""
        basedir = os.path.abspath(path)
+       createAddonHelp(basedir)
        with zipfile.ZipFile(dest, 'w', zipfile.ZIP_DEFLATED) as z:
                # FIXME: the include/exclude feature may or may not be useful. 
Also python files can be pre-compiled.
                for dir, dirnames, filenames in os.walk(basedir):

Repository URL: https://bitbucket.org/nvdaaddonteam/placemarkers/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.
----------------------------------------------------------------

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-addons] commit/placeMarkers: norrumar: Added readme.md and new addon template with automatic documentation support.

Other related posts:
