Skip to content

Basics Quickstart

Benjamin Sloan edited this page Mar 6, 2024 · 3 revisions

Display Controls

On the left is the list of chapters, which you can re-order and rename. In the middle, the main editor. On the right, notes. These three panels can each be toggled on/off with F1, F2, and F3, so you can clear everything but the editor for a fully distraction-free experience, or make room for using a narrow vertical screen.

Speaking of room--the editor panel can be contracted or expanded using CTRL + < or > so you can see your paragraphs as they will look in a narrow paperback or a wide manuscript page. Similarly, you can adjust the font display size with CTRL + - or +.

Navigating Chapters

To cycle through chapters, press CTRL + Up or Down. CTRL + Right and Left will jump between the notes and main editor. These are the Navigation Keys.

To move a chapter up or down in the list, press CTRL + SHIFT + Up or Down. To rename a chapter, CTRL + SHIFT + Left. These are the Alteration Keys.

File Menu

Pressing ALT will reveal the file menu. Here you can import, export, compile, or use many other tools, all easily accessible without a mouse by navigating the menus with the Arrow Keys and Escape. In addition to the usual find/replace, spellcheck, etc., there is a File Manager, a Wi-Fi Manager (if on Linux), an Outliner, and other tools.

Tool Menus

When you choose a tool from the File Menu, it will pop up with a tool menu dialog with input fields, buttons, etc. You navigate through these with the TAB key until you highlight the field/button you want to use. SPACE checks checkmarks. ESCAPE exits any menu/dialog.

Import/Export Tools

These all live under "File" in the File Menu. Please note that "Export" exports separate files for each chapter, while "Compile" saves one file with all chapters compiled together.

Compile/Export options

Currently you can compile/export your work in plain text, MarkdownFic, or .docx, with some helpful options regarding headings and chapter breaks.

WareWoolf's File Format

WareWoolf saves its projects as plain text JSON files so they are both human readable and quickly parsed by Javascript. There is a primary .woolf project file, and individual .pup files for each chapter in a subdirectory.

  • Frankenstein.woolf
  • Frankenstein_Pups
    • 1.pup
    • 2.pup
    • 3.pup

The reason for doing this rather than one (more convenient) file is speed. This way, WareWoolf does not hold your entire (perhaps very long) novel in memory, but only one chapter at a time--the chapter you are viewing.

Please note that the pup files must be kept either in a subdirectory or the same directory as the project file. If you move them, WareWoolf will prompt you to show the new location at load.

Help

And of course, if you ever need help remembering a shortcut, simply remember the shortcut **CTRL **+ H, or use the file menu to open the Help menu, and all will be revealed.