[nvda-addons] commit/placeMarkers: norrumar: Changed version to 1-0-beta.
- From: commits-noreply@xxxxxxxxxxxxx
- To: nvda-addons@xxxxxxxxxxxxx
- Date: Fri, 31 May 2013 14:59:22 -0000
1 new commit in placeMarkers:
https://bitbucket.org/nvdaaddonteam/placemarkers/commits/3ffa1110edaf/
Changeset: 3ffa1110edaf
Branch: master
User: norrumar
Date: 2013-05-31 16:53:32
Summary: Changed version to 1-0-beta.
Affected #: 3 files
diff --git a/buildVars.py b/buildVars.py
index 0b3c206..6bdee6e 100755
--- a/buildVars.py
+++ b/buildVars.py
@@ -16,7 +16,7 @@ addon_info = {
# Translators: Long description to be shown for this add-on on
installation and add-on information
"addon-description" : _("Add-on for setting place markers on specific
virtual documents"),
# version
- "addon-version" : "1.0-dev",
+ "addon-version" : "1.0-beta",
# Author(s)
"addon-author" : "Noelia <nrm1977@xxxxxxxxx>, Chris
<llajta2012@xxxxxxxxxxx>",
# URL for the add-on documentation support
diff --git a/docHandler.py b/docHandler.py
new file mode 100644
index 0000000..8aa718b
--- /dev/null
+++ b/docHandler.py
@@ -0,0 +1,70 @@
+# -*- coding: UTF-8 -*-
+
+# docHandler: module for managing addons documentation
+# See: http://community.nvda-project.org/ticket/2694
+
+import os
+import languageHandler
+import addonHandler
+import globalPluginHandler
+import gui
+import wx
+
+addonHandler.initTranslation()
+
+_addonDir = os.path.join(os.path.dirname(__file__), "..") # The root of an
addon folder
+_docFileName = "readme.html" # The name of an addon documentation file
+_curAddon = addonHandler.Addon(_addonDir) # Addon instance
+_addonSummary = _curAddon.manifest['summary']
+_addonVersion = _curAddon.manifest['version']
+_addonName = _curAddon.manifest['name']
+
+def getDocFolder(addonDir=_addonDir):
+ langs = [languageHandler.getLanguage(), "en"]
+ for lang in langs:
+ docFolder = os.path.join(addonDir, "doc", lang)
+ if os.path.isdir(docFolder):
+ return docFolder
+ if "_" in lang:
+ tryLang = lang.split("_")[0]
+ docFolder = os.path.join(addonDir, "doc", tryLang)
+ if os.path.isdir(docFolder):
+ return docFolder
+ if tryLang == "en":
+ break
+ if lang == "en":
+ break
+ return None
+
+def getDocPath(docFileName=_docFileName):
+ docPath = getDocFolder()
+ if docPath is not None:
+ docFile = os.path.join(docPath, docFileName)
+ if os.path.isfile(docFile):
+ docPath = docFile
+ return docPath
+
+def openDocPath():
+ try:
+ os.startfile(getDocPath())
+ except WindowsError:
+ pass
+
+class GlobalPlugin(globalPluginHandler.GlobalPlugin):
+
+ def __init__(self):
+ super(globalPluginHandler.GlobalPlugin, self).__init__()
+ self.help = gui.mainFrame.sysTrayIcon.helpMenu
+ self.helpItem = self.help.Append(wx.ID_ANY, "{summary}
{version}".format(summary=_addonSummary, version=_addonVersion),
+ # Translators: Tooltip for an addon menu item.
+ _("Open documentation for %s") % _addonName)
+ gui.mainFrame.sysTrayIcon.Bind(wx.EVT_MENU, self.onHelp,
self.helpItem)
+
+ def onHelp(self, evt):
+ openDocPath()
+
+ def terminate(self):
+ try:
+ self.help.RemoveItem(self.helpItem)
+ except wx.PyDeadObjectError:
+ pass
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..68df08c
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,31 @@
+[[!meta title="placeMarkers 1.0"]]
+
+# placeMarkers 1.0 #
+
+It is to be used for saving and searching specific text strings or bookmarks,
on web pages or documents in NVDA's brouse mode.
+The plugin saves the specified strings and bookmarks to text and pickle files.
The name of these files is based on the title and URL of the current document.
+
+This addon is based on SpecificSearch and Bookmark&Search, developed by the
same author. You should uninstall them to use this one, since they have common
keystrokes and features.
+
+## Key Commands: ##
+
+* control+shift+NVDA+s; Opens a dialog for saving a string of text that
you may wish to find on the current document. By default it shows the text
previously saved for this file. If this text is deleted, the text file
containing the corresponding string will be also removed.
+* control+shift+NVDA+f; If the current document has a text file for
specific search, opens a dialog that shows the saved string of text. When you
press OK, NVDA search for the text set on the dialog edit box. If no text file
is found for this document, NVDA announces it without opening Specific Search
dialog.
+* control+shift+NVDA+k; Saves the current position as a bookmark
+* control+shift+NVDA+delete; Deletes the bookmark corresponding to this
position.
+* control+shift+k; Moves to the next bookmark.
+* shift+NVDA+k; Moves to the previous bookmark.
+* NVDA+k; Copies to clipboard the file name, without extension, where
could be saved place markers (positions or a string to search).
+
+## Place markers Submenu (NVDA+N) ##
+
+Using Place markers submenu, under Preferences menu, you can access to
+
+* Specific search folder: opens a folder of specific searches previously
saved.
+* Bookmarks folder; opens a folder of the bookmarks saved.
+* Copy placeMarkers folder; you can save a copy of the bookmarks folder.
+* Restore placeMarkers; you can restore your bookmarks from a
placeMarkers folder previously saved.
+* Documentation file, in your selected language if available, or English
by default.
+### 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.
+
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
Other related posts:
