Tool: Power Passage

Pieter J.
Pieter J. Member Posts: 533
edited November 21 in English Forum

The User Tools Wiki says the following: This page is a collection of links to where others on the forum have made files or tools available.

I, therefore, make the following Tool available in this post:

Power Passage

This Tool is useful for tagging notes, entering passages to a note or sermon, and adding passages to a sermon’s passage list.

This Tool keeps track of Bible References in your clipboard. Each time you copy references it represents one Passage List or Purpose. You can give Passage Lists a temporary name.

This Tool provides quick formatting to change the Passage Lists according to preference before pasting.

This Tool:

  1. will only work on windows
  2. can startup Logos Bible Software if opened as standalone
  3. can attach to Logos Bible Software when launched from the shortcuts bar
  4. should be able to distinguish between logos and verbum (I have logos and can’t test against verbum)

Installation

Just copy the PassagePower.exe and PassagePower.ahk file anywhere you prefer. They don’t depend on each other. If you know AutoHotkey you can delete the executable and just use the PassagePower.ahk script file.

Tool User Interface

The tool's GUI is at the left. On the right, it shows the three major outputs generated for Bible References copied to the clipboard. A Vertical list, Horizontal list, or Tags. Settings for these three major formats can be adjusted on the right side of the Tool's window.

The preview at the bottom of the Tool will display formatted Reference Lists and on occasion some instructions to follow when you start using it.

How it works

  1. Run the Passage Power Tool
  2. Observe the note at the bottom in the preview pane
  3. Copy Bible References from anywhere
  4. A dialog will pop up asking for a Passage List Name.
    1. Name the Passages you copied with an appropriate name. This is only a temporary list and will not interfere with Logos
    2. If you cancel or don’t give a name then your clipboard data will be preserved as copied
    3. If you name the Passage List and press ok, the clipboard will be cleared and waiting for the next copy of Bible References.
  5. The Passage Power window will popup when ok is clicked on the Passage List dialog
  6. At the Left, you have the Passage List’s names you defined
  7. Click on one of the Passage List names
  8. The References List Box will list the References saved for that temporary Passage List
  9. At the bottom is a preview pane
  10. The preview displays the result of settings you enter on the righthand side of the window
  11. Settings:
    1. Direction has options: Horizontal, Vertical, and Tags
    2. Each Direction has default settings for Header, Item List, and Render
    3. Changing a Direction will always load its default. After selection, you can change other settings. Settings are always temporary. If you select another Direction or Passage List it goes back to default settings.
  12. Buttons:
    1. There are four Buttons:
      1. Copy To Clipboard
      2. Direct Paste
      3. Tag Paste
      4. Cancel
  13. Button Scope
    1. The Direct Paste and Tag Paste buttons are only enabled when the Notes Tool or a Sermon is the Active Panel in Logos
  14. Button Actions:
    1. Copy To Clipboard — copies the preview result to the clipboard
    2. Direct Paste — Paste the preview directly into the selected text field in the Notes Tool or Sermon
    3. Tag Paste — Use this action to automatically enter the list of References into a tag field on a note or the Passages field in a sermon (Do not use the mouse or keyboard until the process is complete)
    4. Cancel — The Passage Power Tool will terminate

Memory and Purpose

This Tool has no long-term memory of its own and will not save settings or passage lists. The executable is only 313 KB. Physically it uses about 3.5 to 5 Mb of ram and very little CPU when running. On my CPU it idles at 0%, handles copied References at 0.1%, and copies or pastes formatted text at a max of 2% CPU strain. The more references you copy the larger the Memory and Cpu usage.

The purpose is temporary quick Formatting of a collection of copied Passages to compile notes and sermons faster.

Bugs

I’m not aware of bugs. If you use this tool and find bugs, please report them so I can try to fix them for you.

Source Code

  • The source code is included.
  • The Tool is written in the AutoHotkey Language.
  • The Source is extensively commented

Why is this Tool also Compiled?

Not every user is technical of nature and may need an out-of-the-box experience. If you don’t need the tool as a plug and play then you can delete the executable.

License

The GNU license is included in the zip file.

Disclaimer

PJ disclaims all warranties with regard to this software, including all implied warranties of merchantability and fitness, in no event shall PJ be liable for any special, indirect, or consequential damages or any damages whatsoever resulting from loss of use, data, or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software.

Note

If you fix or expand on the Tool, please make it available.

2275.PowerPassage.zip

Tagged:

Comments

  • Lew Worthington
    Lew Worthington Member Posts: 1,513 ✭✭✭

    This looks really cool. I don't really use notes or the sermon tools in Logos, but I've got AHK experience, so I will give this a test drive. Thank you!

    Lew

  • Pieter J.
    Pieter J. Member Posts: 533

    AHK experience

    With your knowledge you can comment the lines that enable or disable the Direct Paste and Tag Paste buttons. Then the Tool become a global Tool in windows. You can use it anyplace that accept pasting of text.

  • Pieter J.
    Pieter J. Member Posts: 533

    ok ... so I found a bug in my own logic when pasting to tags in a note. Logos find more than one match for a smaller Reference. 1 Kings 1 will also find 1 Kings 16, 1 Kings 16:31, and 1 Kings 1. I suppose because I used those tags previously? The tags are plain text when in a Note document. They are DataTypes in Sermon's Passages.

    There is no useful logic I can observe in the order those matches are presented on screen in a note's tags. So no clever keystrokes will solve this.

    There are two technical ways of solving this. The one involves WPF Automation and the other a screen reader of any kind. There's another easy solution I would personally use and implement. I'll add a character of any kind at the end of my reference entries to indicate the end of a single reference. This way I'll also always know it's a Reference tag on a note.

    If I change "1 Kings 1" to "1 Kings 1·" or "1 Kings 1»" or whatever at the end, I'll always get a unique match in the note tags.

    When I have time I'll fix the code with this easy solution and I'll try to use an invisible or customizable marker at the end.

    Appologies for this error in my logic.

  • Pieter J.
    Pieter J. Member Posts: 533

    I fixed the issue as follows: There is now a settings.ini included with the following defaults:

    Settings.ini

    [Settings]

    eofTag=.

    ToolTips=show

    SystemType=logos

    • eofTag defaults to a period ".". This is a character to use when pasting tags to a Note. The character will make Reference entries unique. “1 Kings 1” will by default be “1 Kings 1.” No other text matching "1 Kings 1" will be found by Logos. In Sermons, the tags will be of the DataType Reference.
    • ToolTips default to "show". To hide ToolTips you can remove the word "show" or add anything in its place.
    • SystemType default to “logos”. This indicates that the "Direct Paste" and "Tag Paste" buttons will only be available for Logos Note and Sermon Panels. To make the system global and turn the buttons always-on, remove the word “logos” or add anything else in its place.

    v.1.0.0.1

    3264.PowerPassage.v.1.0.0.1.zip