README.md (1783B)
1 The draft window allows you to more easily edit prose style text via a task-specific UI. 2 3 # Usage 4 5 The main idea is that we have a Talon controlled text area where each word is labelled with a letter (called an anchor). You can use the anchors to indicate which word you want to operate on. 6 7 An session might go like this for example: 8 9 # Start with the text "this is a sentence with an elephant." in your editor or other textbox 10 draft edit all # Select all the text in your editor and moves it to the draft window 11 replace gust with error # Replaces the word corresponding with the red anchor 'g' (gust in knausj_talon) with the word 'error' 12 period # Add a full stop 13 select each through fine # Select the words starting at the 'e' anchor and ending at 'f' 14 say without # Insert the word 'without' (knausj_talon) 15 title word air # Make the word corresponding to the 'a' anchor capitalised 16 draft submit # Type the text in your draft window back into your editor 17 # End with the text "This is a sentence without error." in your editor or other textbox 18 19 Here's a video of me going through the above commands: 20 21 ![Video of talon draft window in action](doc/talon-draft-demo.gif) 22 23 # Customising 24 25 If you want to change the display of the window you can do by adding some settings to one of your .talon files. See `settings.talon.example` for more details. 26 27 # Running tests 28 29 There are unit tests that you can run from the repository root like this (assuming your directory is called talon\_draft\_window): 30 31 (cd ../ && python -m unittest talon_draft_window.test_draft_ui) 32 33 The reason for the weirdness is because we have everything in the same directory and are doing relative imports.