Skip to content

Commit

Permalink
move settings to "Options" menu, update README
Browse files Browse the repository at this point in the history
  • Loading branch information
bhughes339 committed Sep 11, 2019
1 parent db78d34 commit 0d7e4b6
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 32 deletions.
45 changes: 22 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,40 @@
# AMS Keywords Editor Tool

## Features

* **Built-in International Group Templates** - The International Group Keywords template and Peer Review template (canned text INTLCHANGE and INTLPR respectively) are available from the **File > Load template** menu
* If you have a suggestion for a template that you think should be added, let me know.

* **Custom templates** - Select **Save current text as template** to create a new template which can be loaded from the **File > Load template** menu.
Text editor designed to alleviate the issues with the AMS Keywords section. Great for inhouse and customer entries too!

* **Insert Date** - Insert the current date at the cursor. Setting your mnemonic in the menu will append it to the date.
* Shortcut: <kbd>Ctrl</kbd>+<kbd>D</kbd>
* **NOTE:** There must be enough whitespace to the right of the cursor to fit the date (and mnemonic if necessary)
## Features

* **Copy to Clipboard** - Copies the text to the clipboard properly formatted for pasting into the Keywords section (blank lines appended with a space, etc)
* Built-in International Group templates
* Custom template support
* AMS Keywords-friendly copy/paste
* Today's date/mnemonic insertion
* Automatic crash recovery

* **Paste into Keywords** - Automatically paste the text above the current line in the Keywords section
* Shortcut: <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd>
## Installation

* **Automatic crash recovery** - If the program (or your PC) crashes, the tool will attempt to recover your Keywords the next time you start it.
#### Standalone executable (no installation required)

## Settings
Head to the [latest release page](https://github.com/bhughes339/keywords_editor/releases/latest) and download `keywords_editor.exe`

* **Set mnemonic...** - Causes the Insert Date command to include your mnemonic. Example: 27 Jun 2019 --HUGW
#### (Advanced) Running with AutoHotkey
1) Download [AutoHotkey](https://www.autohotkey.com) v1.1+ and install ([Link to current version download](https://www.autohotkey.com/download/ahk-install.exe))
2) Run `keywords_editor.ahk`

* **Font size** - Changes the text size of the entire program
## Usage

* **Date format** - Changes the format used by the Insert Date command
Load a template from the **File > Load Template...** menu, or start from scratch. Create your entry as you would in AMS—the editor will automatically wrap to 80 characters.

## Installation
To copy the contents of the editor, select **Actions > Copy Keywords to clipboard** (or use the shortcut: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd>). A space will automatically be added to each blank line to ensure proper pasting into the AMS Keywords section.

### Standalone executable (no installation required)
* Head to the [latest release page](https://github.com/bhughes339/keywords_editor/releases/latest) and download `keywords_editor.exe`
Alternatively, you can use the shortcut <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> while editing the AMS Keywords section. This will paste the contents of the editor line-by-line above the current cursor in AMS and add a separator at the end. This is useful when you have multiple change number moves in a single task.

### Running with AutoHotkey
## Options

* Download [AutoHotkey](https://www.autohotkey.com) v1.1+ and install ([Link to current version download](https://www.autohotkey.com/download/ahk-install.exe))
* **Set mnemonic...** – Sets the mnemonic used by the Insert Date command
* **Font size** – Changes the text size of the entire program
* **Date format** – Changes the format used by the Insert Date command

* Run `keywords_editor.ahk`
Settings are stored in `keywords_editor.ini` which resides in the same folder as the executable.

---

Expand Down
16 changes: 7 additions & 9 deletions keywords_editor.ahk
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,6 @@ Menu, FileMenu, Add, Load template, :LoadTemplateMenu
Menu, FileMenu, Add, Save current text as template`tCtrl+S, SaveTemplate
Menu, FileMenu, Add, Delete custom template, :DeleteTemplateMenu
Menu, FileMenu, Add
Menu, FileMenu, Add, Set mnemonic..., SetMnemonic
Menu, FileMenu, Add
Menu, FileMenu, Add, Exit, MainGuiClose

; -- Actions
Expand All @@ -89,10 +87,11 @@ Menu, ActionMenu, Add, Insert date at cursor`tCtrl+D, AddDate
Menu, ActionMenu, Add, Delete current line`tCtrl+K, DeleteLine
Menu, ActionMenu, Add, Format text`tF3, FormatText

; -- View
; -- Options
Menu, OptionsMenu, Add
Menu, OptionsMenu, DeleteAll
Menu, OptionsMenu, Add, Set mnemonic..., SetMnemonic
; ---- :FontMenu
Menu, ViewMenu, Add
Menu, ViewMenu, DeleteAll
Menu, FontMenu, Add
Menu, FontMenu, DeleteAll
for key, value in fSizes {
Expand All @@ -101,16 +100,15 @@ for key, value in fSizes {
Menu, FontMenu, Check, %key%
}
}
Menu, ViewMenu, Add, Font size, :FontMenu

Menu, OptionsMenu, Add, Font size, :FontMenu
; ---- :DateFormatMenu
GoSub UpdateDateMenu
Menu, ViewMenu, Add, Date format, :DateFormatMenu
Menu, OptionsMenu, Add, Date format, :DateFormatMenu

; -- Menu
Menu, MenuBar, Add, File, :FileMenu
Menu, MenuBar, Add, Actions, :ActionMenu
Menu, MenuBar, Add, View, :ViewMenu
Menu, MenuBar, Add, Options, :OptionsMenu
Gui, Menu, MenuBar

Gui, Add, Edit, % "xm r30 vTextSection HwndhEdit gTextSection w" (fSizes[fontSize] * editWidth)
Expand Down

0 comments on commit 0d7e4b6

Please sign in to comment.