RoboJournal Documentation

for version 0.5

Table of Contents

Section I: Installation and First-Run

Section II: Using RoboJournal

  1. Cover Page
    1. What is RoboJournal?
    2. Current Limitations
  2. RoboJournal Fundamentals
    1. Default State
    2. Main Window Anatomy
    3. Making a Connection
      1. Initiating a MySQL Connection
      2. Connected Mode
    4. Disconnecting
    5. Writing a New Entry
    6. Modifying an Existing Entry
    7. Deleting an Entry
    8. Navigating the Chronological Entry List
    9. Tagging an Entry
    10. Exporting an Entry
    11. Searching for an Entry
  3. Working with Tags
    1. Tagging Overview
      1. Best Practices
      2. Accessing the Tagging Interface (Standalone)
      3. Accessing the Tagging Interface (From the Editor)
    2. The Tag Menu and Toggle Filtering Menu
    3. Declaring a New Tag
    4. Applying or Removing Tags
    5. Other Tag-Related Features
      1. Revert Tags
      2. Strip Tags
      3. Filtering Tags
    6. Tag Reminder Window
  4. Exporting Journal Entries
    1. Overview
    2. Exporting a Single Entry
      1. Single Export Options
    3. Exporting the Entire Journal
      1. Bulk Export Options
    4. Creating a Backup of Your Journal with MySQLDump
      1. Backup Options
  5. Using the Search Function
    1. Search Overview
      1. Pattern Match
        1. Pattern Match Filters
        2. Highlighting
      2. Tag Search
      3. Search Interface Overview
    2. Conducting Searches
      1. Accessing the Search Interface
      2. Search by Tag
      3. Search by Pattern
  6. RoboJournal Preferences
    1. Preferences Overview
    2. General Page
      1. Global Preferences
      2. Backend (Database)
      3. Date and Time
    3. Journal Page
      1. Entry Settings and Range
      2. User Information
      3. Highlighting
      4. Behavior
    4. Editor Page
      1. Post-Processing
      2. Appearance
      3. Spell Check
        1. User-Defined Words
    5. Appearance Page
      1. Enabling Custom Styles
        1. Selecting a Font Color
        2. Setting a Background Image
        3. Clearing a Background Image
      2. Style Options
    6. Export Settings Page
      1. HTML Behavior
      2. Fonts and Units
      3. Export Preview
    7. MySQL Settings Page
      1. Default Account
      2. Favorite Journals
      3. Security
  7. Appendix A: Table of Shortcut Key Combinations
  8. Appendix B: RoboJournal Program Arguments
    1. Overview
    2. Date Override
      1. Proper Syntax
        1. Enabling Date Override on Windows
        2. Enabling Date Override on Unix/Linux
    3. Disable Safety Protocols
      1. Proper Syntax