- Home
-
Training Materials
- Keyboards and Fonts
- Linguistics
- Literacy
- Oral Translation
- Others
- Scripture Use
-
Translation
- Scripture Forge
- Adapt-It
- OmegaT Translation Memory Tool
-
Paratext
- Paratext 9 Materials
- Paratext 8 Course Manuals
- Paratext 7.5 Course and Handbook
- Paratext 7.1 Basic Training
-
Paratext Tutorials
- Basic Editing
- Language Source Tools in Paratext 7.6
- View menu tutorial
- Basic introduction to USFMs
- Tips and Tricks
- Introduction to Using Notes
- Cookbook for Consultants
- Menus vary by active project
- Vérifications
- Help! Paratext has stopped working
- Help, send and receive is not working!
- Bible Modules
- Which Paratext Tool When
- Paratext-FLEx Integration Tutorial
- Back Translations and Interlinearizer
- Send-receive and backing up your data
- ParaTExt 8 Test Projects
- New features in Paratext 8
- Voice Marking Tools
- Animated introduction to Paratext and the stages of a translation project
- Setting up a Paratext Project for Success
- Import TXT or Word DOC Files into Paratext Using SILAS
- Illustrations and Maps
- Advanced Unicode handling
- Create a Custom Python Script in the Paratext Menu
- Create a Custom Scripture Check in the Paratext Menu
-
Translator's Workplace
- Adding BdT Menu to Logos 10
- Adding TW Menu to Logos 10
- Logos Bible Software
-
Translator's Workplace Logos Edition
- Logos 8 Get Started Manual
- Opening Logos
- Opening a Resource
- Navigating a Resource
- Reading Multiple Versions
- Basic Search
- Bible Search
- Looking for Bible Facts
- Using the Home Page
- Using the Passage Guide
- Using the Exegetical Guide
- Using the Bible Word Study Guide
- Using the Sermon Starter Guide
- Using the Topic Guide
- Studying English Words Using the Bible Word Study Guide
- Studying Hebrew and Greek Words Using the Bible Word Study Guide
- Prepare a Bible Lesson Using the Sermon Starter Guide
- Look for Information on a Topic Using the Topic Guide
- Saving Your Workspace or Layout
- Arranging the Windows
- Study a Word Using a Reverse Interlinear
- Study a Word Using a Morphology Search
-
Logos edition
- Logos 8 Get Started Manual
- Set up TW Logos for Success
- Quickstart Guide
- Advanced Tips
- Scrolling with other Translation Programs
- Transition from TWFolio
- Troubleshooting
- External Resources
- Low Bandwidth Installation and Updates
- Turn off Logos internet use when visiting a low bandwidth area
- Logos for Beginners Video-based Training
- Translation Workplace - Folio edition
-
Consultant Training
-
Regional Workshops
- Africa Kenya Workshops(LTCT)
- 2021 Africa Virtual Workshop
- 2020 Africa Nairobi
- 2019 Africa Nairobi
- 2018 Africa Nairobi
- 2017 Africa Nairobi
-
2016 Africa Nairobi
- Course Objectives 2016
- Course Schedule 2016
-
Course Program 2016
- HearThis Session 4
- FLEx 8 Lexicon Edit
- FLEX 8 Using text to build lexicon
- LTCT2016 FLEx - Export
- Scripture App Builder Day 1
- LTCT2016 WeSay New Projct
- Create a new project from a FLEX Lift File
- LTCT2016 Wesay Wordlist
- LTCT2016 WeSay Collaboration
- Scripture App Builder Day 1B
- Scripture App Builder Day 1C
- Scripture App Builder Day1D
- Scripture App Builder Day 2A
- Scripture App Builder Day 2A
- Scripture App Builder Day 2B
- Scripture App Builder Day 2C
- Scripture App Builder Day 2D
- Scripture App Builder Day 3A
- Scripture App Builder Day 3B
- Scripture App Builder Day 3C
- Scripture App Builder Day 3D
- LTCT2016 RegExp
- LTCT2016 Paratext1
- Evening Sessions 2016
- Morning Sharing Time 2016
- Responsibilities 2016
- LTCT 2016 Evaluation
- 2015 Africa Nairobi
- 2014 Africa Nairobi
- 2014 Africa Kara, Togo
- 2013 Africa Nairobi
-
2012 Africa Nairobi
- Course Objectives 2012
- Course Program 2012
- LTCT2012 Friday Jan 20
- LTCT2012 Thursday Jan 19
- LTCT2012 Wednesday Jan 18
- LTCT2012 Tuesday Jan 17
- LTCT2012 Monday jan 16
- LTCT2012 Saturday Jan 14
- LTCT2012 Friday Jan 13
- LTCT2012 Thursday Jan 12
- LTCT2012 Wednesday Jan11
- LTCT2012 Tuesday Jan 10
- LTCT 2012 Monday Jan9
- LTCT2012 Evaluation
- Proactive Software Training
- Teaching a Workshop
-
Paratext for Consultants
- 1 Arranging your workspace
- 2 Consultant notes
- 3 Searching and Dictionaries
- 4 Send and receive
- 5 Taking notes during checking
- 6 Keeping track of Biblical term renderings
- 7 Using the Biblical terms tool
- 8 Seeing history and comparing versions
- 9 Understanding the vernacular text
- 10 Spell checking
- Video lessons
- Paratext Supporters
- Digital Publishing
-
Regional Workshops
- Webinars
- Resources
-
»
- Create a Custom Scripture Check in the Paratext Menu
Prerequisite:
Learn about how to write "regular expressions" to match patterns in the text.
Create the expression(s) you want to search for and test them with the regex: prefix in the search dialog. When you have your expression working, you can follow the steps below to create your entry in the Custom Tools menu.
Create the Files
- Make copies of the
SampleCheck and
SampleCheck files.
- Rename them both to reflect the check you will be doing.
Set up the CMS file
\check
This is followed by a space and the name of the check. This check will be featured in the project menu of Paratext under Tools -> Custom tools
\description
The description will show in the dialog that pops up when selecting the check from the menu:
\helpFile
Optionally include an rtf file here. This will place a help button on the dialog box that opens the rtf file. (Not sure if it needs to be RTF -- what about html? Someone try it and update the instructions)
\subMenu
You can create a new submenu for your scripts or include them in one of the existing submenus just by naming it here. Many scripts are listed in the Unsupported menu, but we are not a fan of unsupported products. If your script is designed to help people, wouldn't you want to follow through?
\script
This must point to the name of the python file that you will be editing in the next step.
\rank
This determines where your plugin shows in the list. Rank 1 is near the top. If only Google made it this easy...
Edit the Python File
The Python file contains a number of options that can be configured, and the more you know about Python, the more these will make sense to you. For the most basic RegEx check, you can just comment out this line by typing # in front of it:
# patterns.addPattern(r"\bhad had\b")
Then add your regular expression in the next session that contains the bad pattern you are looking for.
Example:
patterns.addPattern(r"\\v[0-9]", "Missing space after \\v")
Testing your Check
If you run the check and it fails, you may need to use a Python debugger to troubleshoot. You can download the free ActivePython development envirnonment from ActiveState.com. Then you can step through the check in the Python debugger by opening the file tmp.py from the My Paratext Projects\cms directory.
Reference
This reference contains all of the commands that are found in the existing cms file. Because the documentation is sparse, we will add a description as we learn what they do.
\books
Places the Book selector on the dialog:
\check
The name of the check. This check will be featured in the project menu of Paratext under Tools -> Custom tools
\description
The description will show in the dialog that pops up when selecting the check from the menu:
\helpFile
Adding an RTF file will add a help button to the dialog which will open the RTF file
\noText
No idea
\optionDefault
Which setting should this option default to?
\optionDescription
Describe the purpose of this option
\optionHidden
No idea
\optionListAllTexts
?Select box to select a project from all installed projects
\optionLocalized
?Provide options in an additional language. Don't know how this works.
\optionLocalizedName
This is the name which the user will see
\optionName
This is the name by which the option will be know to the python program. It must begin with a letter and not include anything except letters and numbers.
\outputProject
The project to send the results to.
\parameter1
Request user input as a text variable.
\parameter2
Request user input as a text variable
\programToRun
Usually Python
\rank
The order this will show in the Paratext menu
\script
The name of the Python script to run
\subMenu
The submenu you want this script listed under
\supportMessage
No idea
\toHtml
Send output to html
\toList
Send output to the Paratext list
\toText
Send output to a text file
\utf8
Send output in utf8 (probably not needed anymore)
\wordlist
No idea