Skip to content

Commit

Permalink
Update to the latest add-on template
Browse files Browse the repository at this point in the history
  • Loading branch information
mohammad-suliman committed Mar 6, 2021
1 parent 6f548c8 commit 5d90d46
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 13 deletions.
8 changes: 8 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Set default behaviour, in case users don't have core.autocrlf set.
* text=auto

# Try to ensure that po files in the repo does not include
# source code line numbers.
# Every person expected to commit po files should change their personal config file as described here:
# https://mail.gnome.org/archives/kupfer-list/2010-June/msg00002.html
*.po filter=cleanpo
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
addon/doc/*.css
addon/doc/en/
*_docHandler.py
*.html
*.ini
*.mo
*.pot
*.py[co]
*.nvda-addon
.sconsign.dblite
42 changes: 31 additions & 11 deletions buildVars.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,19 @@
# Build customizations
# Change this file instead of sconstruct or manifest files, whenever possible.

# Full getext (please don't change)
_ = lambda x : x

# Since some strings in `addon_info` are translatable,
# we need to include them in the .po files.
# Gettext recognizes only strings given as parameters to the `_` function.
# To avoid initializing translations in this module we simply roll our own "fake" `_` function
# which returns whatever is given to it as an argument.
def _(arg):
return arg


# Add-on information variables
addon_info = {
# for previously unpublished addons, please follow the community guidelines at:
# https://bitbucket.org/nvdaaddonteam/todo/raw/master/guidelines.txt
# add-on Name, internal for nvda
# add-on Name/identifier, internal for NVDA
"addon_name" : "zoomEnhancements",
# Add-on summary, usually the user visible name of the addon.
# Translators: Summary for this add-on to be shown on installation and add-on information.
Expand All @@ -19,7 +24,7 @@
# Translators: Long description to be shown for this add-on on add-on information from add-ons manager
"addon_description" : _("""An add-on which aims to enhance the experience while using Zoom and NVDA"""),
# version
"addon_version" : "1.0",
"addon_version" : "1.1",
# Author(s)
"addon_author" : u"Mohammad Suliman <[email protected]>, Eilana Benish <[email protected]>",
# URL for the add-on documentation support
Expand All @@ -29,16 +34,19 @@
# Minimum NVDA version supported (e.g. "2018.3.0", minor version is optional)
"addon_minimumNVDAVersion" : "2018.4",
# Last NVDA version supported/tested (e.g. "2018.4.0", ideally more recent than minimum version)
"addon_lastTestedNVDAVersion" : "2020.2",
"addon_lastTestedNVDAVersion" : "2020.4",
# Add-on update channel (default is None, denoting stable releases, and for development releases, use "dev"; do not change unless you know what you are doing)
"addon_updateChannel" : None,
}


import os.path

# Define the python files that are the sources of your add-on.
# You can use glob expressions here, they will be expanded.
# You can either list every file (using ""/") as a path separator,
# or use glob expressions.
# For example to include all files with a ".py" extension from the "globalPlugins" dir of your add-on
# the list can be written as follows:
# pythonSources = ["addon/globalPlugins/*.py"]
# For more information on SCons Glob expressions please take a look at:
# https://scons.org/doc/production/HTML/scons-user/apd.html
pythonSources = []

# Files that contain strings for translation. Usually your python sources
Expand All @@ -47,3 +55,15 @@
# Files that will be ignored when building the nvda-addon file
# Paths are relative to the addon directory, not to the root directory of your addon sources.
excludedFiles = []

# Base language for the NVDA add-on
# If your add-on is written in a language other than english, modify this variable.
# For example, set baseLanguage to "es" if your add-on is primarily written in spanish.
baseLanguage = "en"

# Markdown extensions for add-on documentation
# Most add-ons do not require additional Markdown extensions.
# If you need to add support for markup such as tables, fill out the below list.
# Extensions string must be of the form "markdown.extensions.extensionName"
# e.g. "markdown.extensions.tables" to add tables.
markdownExtensions = []
10 changes: 8 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,15 @@ Using this dialog you can :

## Remote control

after a remote control permission is granted, NVDA + O will move the focus in /Out of the remote controlled screen
after a remote control permission is granted, NVDA + O will move the focus in /Out of the remote controlled screen.

Note that the focus should be on one of the meeting controls to be able to remote control the other screen
Note that the focus should be on one of the meeting controls to be able to remote control the other screen!

## Chat history dialog

The add-on has a custom dialog where you can see all chat messages sent during the meeting and while the add-on was running.
To open this dialog, use NVDA + Ctrl + h.
The dialog is very simplistic, it has a list of the sent chat messages with their timestamps also.

## An Important note

Expand Down

0 comments on commit 5d90d46

Please sign in to comment.