Reference

Launch

  • Bundle types

    ME-Mydoc is distributed in two modes: platform independent and platform dependent. The platform dependent package contains the JRE on that platform whereas independent package can be executed on any platform as long as JRE/JDK 8 is installed.

  • For platform dependent package, unzip it and execute corresponding launcher

    On Windows, launch mydoc.exe or mydoc.bat

    On Linux or Mac, launch mydoc.sh. Likely you need to invoke chmod +x mydoc.sh.

  • For platform independent package, an extra step of setting up java command into PATH is required

    On Windows, set PATH=<your java path>;%PATH%

    On Linux or Mac, export PATH=<your java path>:$PATH. You may need to invoke chmod +x -R <jre folder>.

Configuration

  • Setup path on first use
_images/mydoc-install.jpg
By default, user can click Install button to proceed. The directories will be created before the application starts. User can also change one or all directories according to his need.
Note path directory where note files are stored
Doc path directory where document files are stored
Bookshelf path directory where book files are stored
Code path directory where code files are stored
Search cache path directory where search index caches are stored
Temp path directory where temporary files are stored
Trash path directory where deleted files are transferred to

Floating Search Window

  • Global hot key that pops up/hides Floating Search Window
Ctrl + Alt + O : Show/Hide Floating Search Window
  • Keys in text input of floating window
ESC Clear text if any. Hide window if text is empty.
Arrow Down Goto result list if visible, or force to show result list.
Enter Launch first item in the result list.
Double Click an item Launch first item in the result list.
Ctrl + Double Click an item Show property window for the item.
Ctrl + Enter an item Show property window for the item.
Alt + Enter an item Show detailed info in html view.
  • Enlarge floating search window

    Drag floating search window right edge, the input will be enlarged or shrinked accordingly.

Search Query Rules

  • Use , to separate AND conditions. For example, java,programming searches all items whose title has both java and programming.
  • Types can be specified. Currently, there are following types.
b: Book
n: Note
d: Doc
c: Code
t: Tag

By default, items of only enabled types (in menu View ‣ Doc, View ‣ Note, View ‣ Book) are listed.

For example, java,security,b: lists all books containing java and security. It is also equivalent to b:java,b:security or b:java,security.

  • Use to specify full text search. For example, “java” searches all entities having java in its content. d:”java” searches Doc having java in its content. Actually, the query string inside “” follows Lucene query parser syntax. Typical conditions would be AND condition “+term1 +term2”, OR condition “term1 term2”.
  • Multiple types are not valid except for tag. For example, t:alg,b:math searches all books that belong to any tag having substring of alg and whose title has substring of math.

Manage Tags

  • All book, note, doc and code items can be tagged.
  • Upon installation, there are pre-defined tags. “Ebook” tag is for Book categories and “Programming Languages” is for Code feature.
  • User can of course create his own tags by right clicking a tag node
_images/mydoc-tag-menu.png
  • Locate tag instantly. Tags can be instantly located by typing tag path. A tag path denotes tag hierachy. For instance, /Ebook/Art denotes Art tag under Ebook which is top level tag. * is allowed as wildcard char in any part of the query string. For example, *Art* locates any tags having Art in the middle and /Ebook/* having starting string /Ebook/. The search begins from current selected tag and loops over all subsequent tags. ESC to clear query. Enter to start locating.
_images/mydoc-tag-search.png

Note

Note that deleting a tag requires that no item is associated with it.

Item Actions

  • Right clicking an item activates item context menu.
_images/mydoc-menu-right.png
  • Opening an item can also be triggered by pressing Enter or Double Click an item in either search popup list or main window list.
  • Press Alt + Enter on an item and a html hyperlink view is shown.
_images/mydoc-book-hyperinfo.png
  • Property window can be triggered by pressing Ctrl + Enter or Ctrl + Double Click.
  • Doc property window
_images/mydoc-doc-property.jpg
  • Note property window
_images/mydoc-note-property.jpg
  • Book property window
_images/mydoc-book-property.jpg
Double clicking a file in Files list launches the book file.
_images/mydoc-misc-tooltip.png
  • Recently visited items. When an item is newly created or launched, it is traced by history menu.
_images/mydoc-menu-history.png

Add a Doc

  • To create a new Doc, select menu File ‣ Add Doc or press Ctrl + Alt + D when main mydoc window is activated.
_images/mydoc-doc-new.png
  • Multiple files can be committed by clicking Choose button.
  • Modify tags by clicking edit link in Tags field
_images/mydoc-tag.jpg
  • Published Time follows format YYYY, or YYYY-MM or YYYY-MM-DD
  • In case that an existing file to be committed is identified (md5 match), you are given a chance to cancel. You can double click an item in the list and its property window is popped up.

Add a Note

  • There is a global hot key Ctrl + Alt + N that triggers creating a new note.
  • Alternatively, right clicking on tag in the main window and selecting New Note from Tag creates a new note with that tag.
  • There are 4 components in the note editing window. On the right hand side is the source code view. On the left hand side are property view, toolbar and html view respectively.
_images/mydoc-note-edit-with-src.png
  • User can toggle between minimal mode and normal mode. In the minimal mode, only html view is displayed, providing user largest editing view.
_images/mydoc-note-cross-ref.jpg
  • Or normal mode with property and toolbar
_images/mydoc-note-normal-mode.jpg
  • Special toolbar buttons
_images/mydoc-note-button.jpg
They are described as below
_images/note_render_code.png Switch to source editing mode. Highlight source code
_images/note_math_16.png Switch to source editing mode. Render AsciiMath
_images/note_full_16.png Switch to minimal mode
_images/note_prop_16.png Toggle property area
_images/note_src_16.png Toggle source editing area
_images/note_link_16.png Convert selected text to a hyper link
_images/note_image_16.png Insert image link
_images/note_code_16.png Convert selected text to code
_images/note_sync_view_16.png Sync html view with html source code ( left-> right)
_images/note_refresh_16.png Refresh all views.
_images/note_sync_src_16.png Sync html source code with its view ( right-> left)
  • In html view, there are following shortcuts.
ESC Close the window and discard changes. If the note is newly created, it’s not saved at all.
Alt + S Save changes but keep window
F2 Switch minimal/full mode
F5 Refresh
F6 Insert entity reference
F9 Decrease font size
F10 Increase font size
  • In html source editing view, there are following shortcuts.
Alt + S Save changes and refresh html view
F5 Refresh html view
  • Entity Cross Reference The search input is triggered by F6. You can launch the entity referenced by clicking it.
_images/mydoc-note-trigger-cross-ref.jpg
  • Code highlighting and AsciiMath representation
_images/mydoc-note-render-math.jpg _images/mydoc-note-render-code.jpg
You can mix both of code and AsciiMath.
_images/mydoc-note-render-math-code.jpg
The saved html node can be rendered by common web browser.

Note

Once either of them is enabled, the html view becomes read only and you can only edit in html source editing view.

Add a Code

  • A code entity can have multiple snippets associated with it. Each snippet is just some text, highlighted in the editing view by a programming language specified.
_images/mydoc-code.jpg
  • To create a new snippet, click New in Snippets field.
  • By default, Java is the programming language for a newly created snippet. To change it, click edit in Languages field.
_images/mydoc-code-pl.jpg
  • To activate a snippet, select Snippets ‣ <the snippet>.
_images/mydoc-code-snippets.jpg
  • To toggle property view, select Config ‣ Show Property.
_images/mydoc-code-minimal.png
  • To change keymap, select Config ‣ Default Keymap or Config ‣ Vim Keymap
  • Import Code from a directory

Follow menu File ‣ Import Code and select a directory. All source files are recursively imported except those in directories starting with ”.”.

Add a Book

  • To create a new Book, follow menu File ‣ Add Book or press Ctrl + Alt + B when main mydoc window is activated.
_images/mydoc-book-new.png
  • In case that an existing book file to be committed is identified (md5 match), you are given a chance to cancel. You can double click an item in the list and its property window is popped up.
_images/mydoc-book-dup.png
  • In the field Title, input in format Title:Subtitle so that title and subtitle can be recognized automatically.
_images/mydoc-book-title.jpg
Double clicking an existing title, you can tweak other parts. To delete one, select and press DEL.
_images/mydoc-book-title-detail.jpg
  • In Tag list, double clicking the blank line brings up Select Tags window. Switch to All Tags switches to all-tag tree. Double click a tag in list and the candidate tag is removed.
_images/mydoc-tag-book.jpg
  • In Authors field, input full name and its first name, middle name and last name are parsed. If an author with same first name and last name exist, Select an existing author dialog is popped up. Clicking Cancel creates a new author,
_images/mydoc-author-select.jpg
  • If you want to have a deep search of existing author, click Select Existing.
_images/mydoc-author-window.jpg
  • Published Date follows format YYYY, or YYYY-MM or YYYY-MM-DD
  • In Publishers list, double clicking the blank line brings up Select Publishers window.
  • In Series list, double clicking the blank line brings up Select Series window.
  • A Book item can comprise more than one files. Press Add Files to add more.
  • Auto filling meta info by monitoring clipboard. There are several toggles that make mydoc recoginize meta info such as ISBN, existing publisher, etc.
_images/mydoc-book-new-menu.png

Manage Books

  • Custom search
_images/mydoc-book-search-custom.png
  • To add new publishers, select Edit ‣ Publishers
_images/mydoc-publisher-window.png
  • To add new series, select Edit ‣ Series
  • To view books published by one, select Edit ‣ Search Author

Search Hit Highlighting

In search hit highlighting window, matched text and its context are displayed. Detailed rules, see Search Query Rules.

_images/mydoc-highlighter.png

View Control

In menu View, there are options described below
_images/mydoc-menu-view.png
View ‣ Show Tag Show items only associated with selected tag
View ‣ Show Sub Tags Show items that belong to any decendents of the selected tag
View ‣ Show Favourite Show favourite items. Note changing tag will not change
View ‣ Show No Tag Show items that do not have any tag
View ‣ Show All Show all items
View ‣ Doc Show Doc items. Also controls items listed in Floating Search Window
View ‣ Note Show Note items. Also controls items listed in Floating Search Window
View ‣ Book Show Note items. Also controls items listed in Floating Search Window
View ‣ Code Show Code items. Also controls items listed in Floating Search Window

Options

_images/mydoc-dialog-option.png
  • Enable Full Text Search : When enabled, new entities will be indexed once managed. It triggers indexing confirmation dialog, allowing user to perform full indexing or incremental indexing immediately.
_images/mydoc-dialog-index-option.jpg
  • Copy before opening : When selected, the launched Doc will be copied to temp directory configured by user and then default program is invoked to open the shadow file, in order to avoid damage to the file.
  • Show hidden : Users can mark hidden property of Doc or Note so that they will not be listed in main window or floating search window if Show hidden is disabled.
  • Move to Trash : When enabled, deleted items are moved to trash folder in stead of vanishing completely.