myBase Desktop 7.x User's Manual


  1. Installing myBase Desktop

    • GNU/Linux

      For GNU/Linux, simply extract the downloaded .tar.bz2 package into your home directory, by using a GUI archive tool, or running the command: 'tar jxvf mybase.tar.bz2'; then you can double click on the file 'myBase.run' within X11 file manager; Or, run the command line 'myBase.run &' in Terminal; It's recommended to create a launcher for myBase.run on the X11 desktop for the convenience of double-clicking on it to launch the program.

      With different distributions of GNU/Linux, you may need to manually install additional packages to resolve the shared library dependencies. To check out the library dependencies for myBase 7.x, open a Terminal, change to the program's directory, and run the command 'ldd myBase'.

      In addition, if you use a 64-bit Linux systems, you'd also need to have the 32-bit compatibility libraries properly installed.

    • Mac OS X

      For Mac OS X, open the downloaded .dmg package file, then drag the myBase icon and drop into the system Application folder, then you can double click on the program's icon to start it.

    • Windows

      For Windows, run the downloaded setup program and follow the instructions; You'll need to select the target directory and program group name; Then you can double click on the program's icon to start it.

  2. Uninstalling myBase Desktop

    Before uninstalling myBase Desktop, you'd need to first create backup for your .nyf databases.

    • For GNU/Linux

      Simply remove the program's directory.

    • For Mac OS X

      Trash the installed myBase icon from the Application folder.

    • For Windows

      Select the "Uninstall myBase Desktop 7" menu item from the Start menu, and press "Yes" to confirm.

  3. Building up databases

    To build up a database, please select the [File - New database] menu item to create a new database, then you can add info items within the outline view, input text in the HTML editor, insert files as attachments, and optionally make info items linked with other info items or the calendar, apply labels/tags, make hyperlinks, and assign custom icons to individual info items. See below for detailed instructions.

    1. Creating databases

      Before you can input your data within myBase, you'll need to create a new database (.nyf file) at first, whereby you can input your data and organize them in the tree outline form. In order to create a new database, please select the [File - New database] menu item, then determine the target .nyf database file path and/or set a password for data security.

    2. Adding info items

      The new database automatically opens when it's created. Then you can insert new info items in the outline tree view by selecting the [Organize - New child item] or [New sibling ...] menu items. Each info item accepts a piece of HTML text as default content. When clicking on an info item within the outline view, the default HTML content will open in the integrated HTML editor, and you can edit or format the content with ease;

    3. Adding attachments/shortcuts

      Each info item accepts a collection of files as attachments. The attached files can be either a real file inserted and stored in the database, or a shortcut linking to a document stored in the local file system. To insert files as attachments, please select the [Attachments - Add attachments] menu item; To insert file shortcuts, please select the [Attachments - Add shortcuts] menu item.

  4. Organizing info items

    Basically, you can organize info items in the tree outline form, myBase also implements additional organizing methods, such as item links, symbolic links, linking with calendar, and labelling etc.

    1. Moving info items

      First select one or more info items within the outline view, then select the [Organize - Move - Move item up/down...] menu item to move the selected info items up/down; or select the [Organize - Move - Move to ...] menu item to move them to a specified item as child items; or select the [Organize - Move - Promote to top level] menu item to move them as top-level items.

    2. Item linking

      Each info item can have a list of related info items, which will be listed out for reference when the item opens. Double-clicking on a related item will open the item. To make an item link, please select the [Organize - Link - Link info item ...] menu item, then select a target item to link.

      The item links can also be inserted into HTML content as hyperlinks, one can click on the hyperlinks to open the target items. To insert an item link into HTML content, please select the [Edit - Insert - Insert item link] menu item, then select a target item to link;

      In order to link an info item from the currently selected text within the HTML content, please right-click and select the [Edit hyperlink ...] menu item, then press [Info item] button and select a target info item to link;

    3. Symbolic linking

      Symbolic links (Symlinks) are a special kind of info items which can be inserted into the outline tree. Symbolic links behave more likely shortcuts to real info items. There're several synonyms that may describe the concept, such as virtual-node, clone-node, shortcut, transclusion, reference etc. One can create a symlink just containing a reference to another real item. Comparing to the real item, the symlink doesn't save its own data. When clicking on a symlink item, it simply displays content of the referenced item instead of its own. If the referenced item is also a symlink item, it goes forward on the chain till the real item is reached, or an endless loop is detected. Within myBase, you can create as many symlinks as you see fit. The drawback is that when you copy/export a branch contains symlinks, they're ignored. To insert a symbolic link, please select the [Organize - Link - Symbolic link to ...] menu item, then select a target info item to link.

    4. Each info item can be linked with a calendar date by selecting the [Organize - Link - Link calendar ...] menu item. By default, the associated calendar date will be displayed in title text in the outline tree.

    5. Labeling info items

      In addition to the basic tree structured outline, the label tree provides the second method for categorizing info items. To label an info item, please select the [Organize - Link - Label info item ...] menu item, then select and check one or more appropriate labels to apply to the info item.

      The label tree is fully customizable and you can add as many labels as you need. To add custom labels, please select the [Organize - Add child item] or [Add sibling ...] menu item within the label tree view;

    6. Bookmarks

      myBase supports bookmark of paragraphs inside HTML content; To define a bookmark of paragraph inside HTML content, select the [Bookmarks - Add to bookmarks ...] menu item.

      Note that myBase needs to insert an Anchor into HTML content when adding a bookmark, so it can scroll down the HTML content to the bookmarked paragraph when triggering the bookmark item.

      myBase also supports hyperlinks to bookmarks from within HTML content. To make a hyperlink with a bookmarked item/position, please first highlight a part of text in the HTML editor, then select [Edit - Edit hyperlink ...] menu item, and then select an item from in the 'Bookmark' list to link;

    7. Custom icons

      Each .nyf database can store a collection of bmp/png/jpg/gif image files (16x16px) as custom icons, which can be applied to info items and label items.

      Newly created databases contain several pre-defined icons ready to use, but you may want to import additional desired images as custom icons.

      To import image files as custom icons, please select the [Organize - Custom icons ...] menu item, the [Custom icons] window pops up, wherby you can press the [Add] button to import image files as custom icons; To apply a custom icon to info items, double click on an icon, or select an icon and press the [Apply] button.

    8. Custom styles

      myBase 7.x supports custom font/color attributes for individual info items, this makes the outline tree more usable and clearer.

      To set custom styles for info items, please try to first select the outline items and then select the [Organize - Custom styles ...] menu item.

    9. Sorting child items by alphabet

      Info items or label items can be sorted by alphabet or date modified in ascending/descending order. The sorting utility rearranges child items under an item or in the whole sub branch. To sort child info items, please switch to the outline tree view and select the [Organize - Sort child items] menu item. To sort sub labels, please switch to the label tree view and select the [Organize - Sort child items] menu item.

    10. Sorting child items by calendar

      Info items can be sorted by associated calendar date by selecting the [Organize - Sort child items by calendar] menu item.

      To make an info item associated with the calendar, please select [Organize - Link - Link calendar] menu item.

    11. Auto numbering

      The [Organize - Auto number ...] utility helps add ascending numbers to title of each child items under the current item. If the titles already contain numbers, it simply clears the numbers, then you can run this utility again to re-number them.

    12. Duplicating info item

      The [Organize - Duplicate info item ...] utility makes a duplicate of the current info item (branch). This is useful when you want to make a copy of the item and then move it to another item.

    13. Copy tree icon

      The [Organize - Copy tree icon ...] utility copies the current tree icon to all its child items in the outline tree.

  5. Capturing data from various sources

    In addition to individually adding info items while building a database, myBase provides a set of utilities that help capture data from in various data sources (e.g. disk files, directories, MS-Office and webpages etc.). See below for detailed instructions. Most of import/export specific utilities listed below are written in Javascript, and you have the convenience of customizing the script code or writting your own plugin scripts for particular data processing. For more info on writing plugins, please visit myBase Plugin Development.

    1. Importing directory tree

      This utility imports a disk directory tree (including sub trees and files) into the current .nyf database as sub branches, each folder creates an info item in the outline, and files are imported as attachments (or hyperlinks). Note that .html documents are inserted as default content.

      To import a direstory tree, please select the [Capture - Import directory tree ...] menu item, then choose a directory to import.

      Note that importing files as attachments copies all files into .nyf databases, that may bloat the database file size. If you'd want to keep databases compact, please be sure to select the [Save files as hyperlinks] option, that imports the directory tree structure with files inserted as hyperlinks, instead of copying whole files into the database storage; It inserts file info (e.g. path, size and date modified) into item content. Clicking on the hyperlinks launches the original documents as long as they're associated with programs installed on the system.

    2. Importing .nyf database

      This utility imports info items from another .nyf database into the current database as sub branches.

      To import info items from an existing .nyf database, select the [Capture - Import data from .nyf database] menu item, then select a .nyf file, and select an info item (branch) to import.

    3. Importing files as child items

      This utility imports selected files as child info items, each file creates an info item under the current item, HTML documents are inserted as item's default content, while other files inserted as attachments. When importing local HTML documents, accompanying images (if existing) will be smartly imported as well.

      To import files as child items, please select the [Capture - Import files as child items ...] menu item, then select one or more files to import.

    4. Importing MS-Word documents

      This utility imports MS-Word documents into the current database as child info items. Unlike the [Capture - Import files as child items], this utility attempts to convert .doc documents into HTML documents and save as item's default content;

      To import MS-Word documents, please select the [Capture - Import MS-Word documents ...] menu item, then select one or more .doc files to import.

      This utility requires MS-Word to be properly installed on the system for performing document format conversion via OLE Automation (a Windows feature).

    5. Importing MS-Word outline

      This utility imports an MS-Word document with outline items imported as child info items. Each MS-Word outline item creates an info item with the original hierarchical outline levels preserved, and text content are saved as default content in each info items.

      To import MS-Word outline, please select the [Capture - Import MS-Word outline ...] menu item, and then select a .doc file to import.

      This utility requires MS-Word to be properly installed on the system for data exchanging via OLE Automation (a Windows feature).

    6. Importing MS-Outlook items

      This utility imports MS-Outlook items into the current database as child info items. To import MS-Outlook items, you'll need to first launch MS-Outlook and select one or more items, and then switch back to myBase and select the [Capture - Import MS-Outlook items] menu item, the selected MS-Outlook items will be imported as child items with text content saved within each new info items.

      This utility requires MS-Outlook to be properly installed on the system for data exchanging via OLE Automation (a Windows feature).

    7. Importing OPML items

      This utility imports OPML items from a .opml document into the current database as child info items. To import OPML items, please select the [Capture - Import OPML items ...] menu item, and then select a .opml file to import.

    8. Capturing webpages/snippets

      myBase accepts any type of files as attachments. To import existing HTML documents saved in local file system, simply insert them as attachments, by selecting the[Capture - Import files as child items] or [Capture - Import diretory tree ...] menu item. This way, each HTML document creates a child info item.

      If you'd want to capture and save webpages (or snippets) directly from within your web browser while surfing on the web, please try the Webcollect addon program, which is now available for Firefox 35+ and Chrome 41-. While surfing on the web with the Webcollect addon properly installed, you can right-click on a webpage and select the [Save with myBase] menu item to capture and save the whole webpage (or highlighted part of the webpage) including accompanying images within the currently working myBase database.

      Before capturing a webpage, you'll need to first launch myBase and open a database, and then instruct WebCollect to transfer the captured webpage/snippet to the currently working database.

      In addition, WebCollect addon is based on NPAPI, but some web browsers (Google Chrome) are ending support for NPAPI in future versions. Currently, WebCollect requires Mozilla Firefox 36+ and Google Chrome 41- to work normally; If you're using Goolge Chrome 42/43/44, you'll need to manually enable NPAPI.

    9. Importing text by delimiter

      This utility imports text content as child items, from a text file with text separated by a delimiter, like this,

      Some text lines A
      ----------
      Some text lines B
      ----------
      Some text lines C
      ----------
      Some text lines D

      Where the '----------' is the text delimiter.

      To import the text file as child items, please select the [Capture - Import text by delimiter] menu item, then select a text file, and specify a delimiter. In order to import a text file with each text line saved as a child item, simply supply the '\n' as delimiter.

    10. Clipboard monitor

      The clipboard utility helps capture info from other programs by monitoring the system clipboard. Once the clipboard monitor is activated, any changes on the clipboard will trigger a popup window and ask for confirmation to save the clipboard content within the currently working database.

      To activate the clipboard monitor, please select the [Capture - Clipboard monitor] menu item. Selecting the menu item again deactivates the clipboard monitor.

      Note that Mac OS X doesn't allow clipboard events to trigger the popoup window, myBase displays a top-level icon on desktop instead, so you can actively click on it to trigger the popup window after copying content to clipboard, or simply drag content and drop onto the icon to trigger it.

  6. Sharing data in various formats

    1. Exporting directory tree

      This utility maps the outline as a directory tree in file system, each info item creates a sub directory (or folder), item content are exported as .html documents (named with defnote.html), and attachments (webpages, images, documents, etc.) are exported as files and stored in the directory tree.

      To export database as a directory tree, please select the [Share - Export directory tree ...] menu item, then choose a folder location to export the directory tree.

    2. Exporting HTML tree

      This utility exports item content as a collection of webpages indexed within an HTML tree. The webpage layout is divided into two panes, the outline items are listed in the left pane, and item content is shown in the right pane when clicking on the item by mouse.

      To export HTML tree, please select the [Share - Export HTML tree ...] menu item.

    3. Exporting current branch to a .nyf file

      This utility transfers the current outline branch (including item content and sub items) into another .nyf database. If the target database already exists, you will need to select a destination outline item to save the content. Otherwise, a new .nyf database file will be created to save the content.

      To export branch to .nyf file, please select the [Share - Export branch to .nyf file] menu item.

    4. Exporting selected attachments

      This utility exports the currently selected attachments to a specified folder in the file system.

      To export selected attachments, please select the [Attachments - Export attachments ...] menu item.

    5. Exporting all files to a folder

      This utility exports all text content and attachments in the current branch into a folder.

      To export all files in the current branch, please select the [Share - Export files to folder ...] menu item.

    6. Exporting MS-Word outline

      This utility exports outline items and item content to MS-Word within the outline view via OLE-Automation. It's useful for writters/researchers to build up the hierarchical outline and then transfer into MS-Word for publishing/printing.

      To export outline and item content to MS-Word outline, please select the [Share - Export MSWord outline...] menu item, then select the content/range being exported to MS-Word, and a filename to save the content.

      This utility requires MS-Word to be properly installed on the system for data exchanging via OLE Automation (a Windows feature).

    7. Exporting .exe standalone databases

      myBase 7.x .nyf databases are compatible with myBase Viewer 6.5.x, which provides the .exe database feature. In order to export .exe database, you'll need to first download and install myBase Viewer 6.5.x, and then select the [Share - Export .exe database] menu item from in myBase Viewer 6.5.x;

      Note that the .exe database is a Windows platform feature, it is currently not available for Linux and Mac OS X.

    8. Exporting CHM project

      This utility exports item content as CHM project files, which can be compiled into CHM ebooks, by utilizing Microsoft HTML Help Workshop.

      To export CHM, please select [Share - Export CHM project ...] menu item, then select a temporary destination folder where the CHM project files will be stored. Once the CHM project files are successfully generated, you can double click the generated .hhp file in the destination folder, HTML Help Workshop will load the project files, and then you can select the [File - Compile ...] menu item to make the CHM ebook.

      myBase doesn't include the Microsoft HTML Help Workshop in its package, you'll need to download it separately from Microsoft Download Site and have it properly installed on the system before compiling the CHM projects.

      If you have Microsoft HTML Help Workshop installed in its default folder (i.e C:/Program Files (x86)/HTML Help Workshop/, or C:/Program Files/HTML Help Workshop/ on Windows XP), myBase will automatically invoke the CHM compiler to compile the CHM project, and generate the .chm document, and then clean up temporary files in one go, without having to manually run the CHM compiler.

      Note that the .CHM compiler is a Windows platform specific feature, it is currently not available on Linux and Mac OS X.

    9. Exporting text with delimiter

      This utility exports text content in current branch as a plain text file with text content separated by a given delimiter.

      To export text with a delimiter, please select [Share - Export text with delimiter] menu item, then enter a text delimiter, and determine path to the destination .txt file.

    10. Exporting data records to CSV file

      This utility searches item content in the current branch for data records by the given field names, and results (found records) will be saved into a .csv file, which is compatible with spreadsheet software or relational database programs.

      To export data records to a .csv file, please select [Share - Export data records to CSV file] menu item, then enter field names (sepearted comma), and determine path to the destination .csv file;

      For instance, giving the field names: "name1|name2|name3|name4", it searches for data records in item content having text like this;

      name1 = value1
      name2 = value2
      name3 = value3
      name4 = value4
      and the resulting .csv file will have the records like this;
      "name1","name2","name3","name4"
      "value1","value2","value3","value4"
      ... ...

      In addition, the [Edit - Text utilities - Edit with fillable form] utility allows to easily edit this kind of data records within a fillable form.

  7. Database maintenance

    1. Set password

      Database password is used to protect database from unauthorized access. Within v7.x, database password applies to data newly added into the database, and is unchangeable once it's been set; so, it's recommended to set a password as soon as the database is created, if you need a password-protected database.

      To set a password for the current database, please select [File - Maintenance - Set password] menu item.

      If for any reason you'd like to change a database password, please try to replicate the database into a new database, by selecting the [File - Maintenance - Replicate database ...] menu item, that allows you to set a new password for the replication database.

    2. Undelete info items and files

      Any changes to the item content produces a new revision and trashes the previous revision into the recycle bin; Deleting an info item (branch) also trashes the item into the recycle bin. That's to say, we have a chance to undelete and retrieve the transhed entries if needed.

      To undelete trashed entries, please select the [File - Maintenance - Undelete items] menu item, then select the desired entries to undelete.

      Note that the trashed entries will be preserved till you run the [File - Maintenance - Empty recyle bin] utility; In addition, the [File - Maintenance - Replicate database ...] utility doesn't replicate trashed entries, so the new replication databases won't contain any trashed entries;

    3. Optimize for size

      myBase by default stores all outdated revisions and trashed entities within the database. This may waste some disk space and may bloat the .nyf database file. If you'd want to optimize database for size, please first select the [File - Maintenance - Empty recyle bin] menu item to wipe off the trashed entries, and then select the [File - Maintenance - Optimize for size] menu item to eliminate fragments from within the .nyf database file. After this operation, all trashed entries are wiped off permanently.

    4. Backup database

      It's highly recommended to frequently create backup for important databases in case of file corruption or disk failure.

      To create a backup for the currently working database, please select the [File - Maintenance - Create backup] menu item, then you can customize the file path and file name for the backup files.

      In addition to the inbuilt backup utility, you can also create backups by simply duplicating the .nyf files within the local file system.

    5. Replicate database

      The [File - Maintenance - Replicate database...] utility replicates the current database to a new one that allows to set a new password.

      This utility ignores trashed entries while replicating a database, consequently, the new replication database contains no revision history records available.

      The new replication database is automactically done with size optimization, so it is useful when you want to eliminate space fragment and make the database file size compact.

    6. Recover database

      The [File - Maintenance - Recover database...] utility invokes the command line tool "ssg5recover" to recover database from a given corrupted .nyf file. The command line tool is not shipped within the setup package, you'll need to download it separately from on the webpage;

    7. Compression level

      The [File - Maintenance - Set compression level ...] utility is used to adjust the compression level for the current database. You can set the compression level to a number from 0 to 9; "9" stands for maximum compression ratio of data, "1" for minimum compression ratio but with a higher performance, while "0" simple disables the integrated Zlib compression algorithm.

      Note that changes to the compression level only apply to data newly added to the database.

  8. myBase provides several search utilities, e.g. [Find as you type], [Search with index], [Find partial workds] and [Search with RegExp]. The first two utilities require index data for fast find and support boolean searches; while the [Find partial workds] and [Search with RegExp] are scanning-based and capable of handling regular expressions, and searching for partial words.

    1. Index databases

      Before you can use the [Find as you type] and [Search with index], you'll need to first built/update index data. To build/update index, please select the [File - Maintenance - Update indexes] menu item.

    2. Find as you type

      The [Find as you type] feature helps search for a phrase as you type. Pressing F3 moves input focus into the edit box whereby you can type in a phrase to seach for.

      Index data is required, please be sure to first build or update index data.

    3. Both [Find as you type] and [Advanced search] support the boolean operators (AND, OR, NOT). You can type a search phrase like this: w1 AND w2 OR w3 OR w4 NOT w5. The boolean operators (AND, OR, NOT) can be abbreviated with the equivalent charaters (+, |, -) or (&, |, !). Therefore, you can also type the search phrase like this: w1 + w2 | w3 | w4 - w5.

      Note that each boolean operator requires a leading space and a trailing space, otherwise it doesn't take effect.

    4. Search with RegExp (Search for words or partial words)

      myBase also implemented the [Use regular expression] option, which allows to search with regular expressions.

      To search with RegExp, please select the [Search - Advanced search] menu item, then enter a regular expression (only pattern string without begining/ending slashes, just like this: wj{2,}soft\.com), found items (if any) will be listed in the query results window.

      This utility scans content in the datbase, no index data required.

    5. Find in text

      This utility looks into the current HTML content for given text, it behaves like the 'Find' command in Windows Notepad.

      To find in text content, please select the 'Edit - Find in Text ...' menu item, then type in a word/string/text to find.

    6. Search by custom icons

      The [Search - Search with custom icons ...] utility scans the current branch or whole outline tree for those info items having a given custom icon.

      This utility traverses the outline tree and looks at the custom icons for matched info items, no index data required.

    7. The [Search - List all related items ...] utility scans the item links table iteratively for those info items directly or indirectly linked with the current info item. For example, item A is linked with item B only, while item B is linked with item C and D, when you select the [Search - List all related items ...] menu item on item A, all of them (A, B, C and D) are listed out.

      This utility looks into the item links table for matched info items, no index data required.

    8. List recently modified entries

      The [Search - List recently modified entries ...] utility scans the whole database for those entries (info items, item contents, attachments and shortcuts) modified within a specified date period, e.g. today, this week, last week, this month, etc...

      This utility traverses the outline tree and looks at timestamp of each entries, no index data required.

    9. The [Search - Search local file system ...] utility scans all files under a directory for given words or Regular Expressions. You can select to search file names only, or file content, or both.

      To search with RegExp, please be sure to add a pair of slashes surrounding the RegExp pattern string, like this: /pattern/i

      If you choose to search file content, it attempts to parse each documents by utilizing the corresponding document filters installed on the system. It may take much time to parse a large number of documents under a directory, so this utility maintains an internal .nyf database to cache textual content of parsed documents, this way, later searches on the documents could get faster. The cache database is saved in the current user's home directory with the file name "Search file system.nyf", you may remove it at any time as you see fit;

      Note that this utility may take quite a while to go through a whole file system, so it's recommended to restrict the search range to the folder as close as possible to the target files.

  9. Text content editings

    1. Edit HTML source

      The [Edit - Edit HTML source] utility allows to edit HTML source code for the current item's content.

      myBase v7.x doesn't accept scripts in the HTML source, so please avoid using scripts (dynamic content) in HTML source code. Scripts (dynamic content) may cause confusion with the inbuilt WYSIWYG HTML editor.

      However, you can freely use CSS2/3 in the HTML source code so long as you prefer using CSS rather than the inbuilt WYSIWYG HTML editor. In fact, some of inbuilt text formatting tools have been using CSS2/3.

    2. Edit plain text

      The [Attachments - Edit plain text] utility allows to edit current HTML content or current attachment as plain text. If any attachment file is currently selected, it attempts to load it as plain text for editing, otherwise, it loads the current item's HTML content as plain text for editing.

      Note that this utility always saves text content in UTF-8, no matter what encoding type it's originally saved in.

      Warning: This utility can only be used to edit text files; Editing arbitrary/binary files as plain text will destroy the files.

    3. Paste clipboard data

      The [Edit - Paste] utility simply pastes the preferred data from clipboard; In general, it first looks into Clipboard and see if any HTML content available to acquire, otherwise it looks for Images, Plain Text and URLs. However, when pasting random HTML content into a Table section, only plain text is accepted.

      The [Edit - Paste special ...] utility allows to choose one of data formats available in the Clipboard. This is useful when you want to paste a specified data format instead of the preferred one.

      The [Edit - Paste unformatted] utility simply pastes plain text available in the Clipboard.

    4. Make into table

      The [Edit - Text utilities - Make into table ...] utility converts the currently selected tabular text into an HTML table.

      The tabular text must be separated with a special character or string, for example,

      1,2,3,4,5,6,7
      a,b,c,d,e,f,g
      A,B,C,D,E,F,G

      It will be converted into an HTML table by using the comma delimiter.

    5. Edit with fillable form

      The [Edit - Text utilities - Edit with fillable form...] utility allows to edit the [key=value] data records within a fillable form. You can edit existing [key=value] records or append new keys (field names) and values with ease.

      In addition, the [Share - Export data records to CSV file] utility helps export existing data records as .csv file for data exchanging with spreadsheet software or other database programs.

    6. Custom stylesheet

      Custom stylesheet defines text fromatting data (e.g. font name, size, style and colors), that can be applied to the currently selected text in the HTML editor.

      To define a stylesheet, please select the [Stylesheet - Defined stylesheet ...] menu item, then determine a name, and setting the text attributes to define the new stylesheet;

      If you first highlight a sample text within the HTML editor, and then select the [Stylesheet - Defined stylesheet ...] menu item, it attempts to extract formatting data from the highlighted text to initialize the new stylesheet;

      To apply a custom stylesheet to the selected text in other item content, please select [Stylesheet - Name of stylesheet] menu item.

    7. Remove unwanted spaces/returns

      Select the [Edit - Text utilities - Remove unwanted spaces...] menu item, then choose what kind of spaces you'd want to eliminate from the currently selected text within the RTF editor.

    8. Find and format text

      The [Format - Find and format ...] utility allows to find a given text in the HTML content and apply font/color attributes to the matches.

    9. Sort text lines by alphabet

      Select the [Edit - Text utilities - Sort text lines...] menu item to sort the currently selected text within the HTML content.

      Note that it processes the selected content as plain text, and may lose formatting data from individual lines.

    10. Syntax highlight

      The [Edit - Syntax highlight] utility makes the selected source code highlighted by syntax. If no source code currently selected, it assumes all text content in the HTML editor to be highlighted by syntax.

      Most of familiar programming languages are supported including C/C++, Qt/STL, Java, Javascript, C#, Delphi, VB, Ruby, PHP, Python, GO, Perl, SQL, Bash, Objetive-C, Swift, etc.

    11. Insert quick text

      The [Edit - Insert - Insert quick text] utility allows to choose and insert a text content from the pre-defined quick text list. To define a quick text file, simply save quick text as *.q.txt files in either the program's folder, or in the current database's folder, and/or in the './quicktext' sub folder under the program's folder.

    12. Make uppercase/lowercase

      The [Edit - Text utilities - Make uppercase/lowercase] utility makes the currently selected text into upper/lower case.

    13. The [Edit - Edit hyperlink ...] utility makes the currently selected text into a triggerable hyperlink. In addition to web URLs, you can also make the text hyperlink to either an info item, or an attachment file, or a local file.

    14. Copy text to title

      The [Edit - Copy text to title] utility copies the currently selected text in HTML content as the current info item's title. The leading/trailing spaces in the title text will forcedly be trimmed.

    15. Revision history

      The [Edit - Revision history] utility allows to revert current item content to one of history revisions ever trashed into the recycle bin.

      Note that this utility maintains the revision history within the recycle bin, so the revision history will be available till you run the [File - Maintenance - Emtpy recycle bin] utility.

  10. Misc. utilities/features increasing personal productivity

    1. Keyboard shortcuts customization

      To customize keyboard shortcuts, please select [View - Options ...] menu item, then click the [Keyboard] tab, and hit a hotkey (a keyboard combination or a function key) on the target items within the action list to define it.

    2. Items for today (or next week)

      Select the [Search - Items for today (or next week)] menu item to list out info items linked with the calender and being due today or in next week;

      To make info items linked with the calendar, please select the [Organize - Link - Link calendar ...] menu item.

    3. Evaluating math expression or js code

      The [Tools - Evaluate expression or js code] utilities calculates the currently selected Math expression in the HTML content, and inserts the resulting values of the expression into the content; For example, the expression "1+2+3" will be calculated and turned into "1+2+3 = 6";

      If there's no text selected in the HTML content, a text box pops up, whereby you can type in an Math expression or js code to evaluate, the result of the expression or js code will not be inserted into the content, but only displayed in an 'Alert' window.

      Both Math expressions and js code you input must conform to Javascript Syntax, and you can use all of those classes and functions pre-defined in Javascript. For example, "new Date().getTime()" returns the current UNIX time in Milliseconds;

      In addition, myBase plugin APIs is fully supported.

    4. Display statistics

      The [Organize - Display statistics] utility looks into the current outline branch and reports statistics on file size.

    5. Batch redirect shortcuts

      The [Attachments - Batch redirect shortcuts] utility replaces file path of shortcuts with a new folder path. It's useful when linked files/documents have been moved to another disk folder, you can update exising shortcuts with the new folder path. without having to re-create all the existing shortcuts.

    6. Compare folders

      The [Tools - Compare folder] utility looks into two given disk folders, and attempts to detect difference between the two folders. It only checkes filenames and attributes (size, date modified) of files existing in the two folders, and then report difference if any.

    7. .

  11. myBase Plugin APIs

    1. myBase Plugin Javascript APIs

      myBase Desktop 7.x is built with the Qt Framework and the Structured Storage Library, myBase exposes its APIs in both C/C++ and JavaScript to extend the functionality by writing plugins; myBase 7.x has implemented tens of plugins inbuilt as the essential functionality. For third-parties to write plugins, Javascript APIs are currently recommended, while the C++ APIs are complicated and obsolete. If you'd like to find more plugins or have interest in myBase plugins development work, please go here.

      Below is a list of online resources that would help you learn the Javascript programming language;

  12. FAQs

    1. How do I get started with myBase Desktop?

      First of all, you'll need to download a copy of myBase Desktop that is appropriate for your system platform (Linux/Mac/Windows), and then have the program properly installed on your system.

      Using myBase is simple. Before you can input your own information, you'll need to first create a new database (.nyf files), then insert info items within the tree outline view; Each info items accept HTML text as default item content, and any files as attachments in the Attachment pane. All information are automatically compressed and saved in the .nyf database. Here is a simple list of essential instructions using myBase.

      • To create a new .nyf db, please select the 'File - New database' menu item,
      • To insert info items in the tree outline, please select the 'Organize - New item ...' menu items, which inserts new info items as either sibling or child items as you see fit.
      • To insert files as attachments or shortcuts, please select the 'Attachment - Add attachments/shortcuts' menu item.
      • To save changes, select the 'File - Save' menu item, or press 'Ctrl+S'.
      • To import materials from other sources, select the 'Capture - Import...' menu items.
      • To export info items, select the 'Share - export ...' menu items.
      For demonstration, myBase Desktop includes a sample .nyf database which can be loaded by select the 'Help - Sample database' menu item.
    2. Does myBase load a whole database into computer Memory?

      No. myBase supports the 'Load on Access' feature, it only loads the currently working items into the computer's RAM, without having to load a whole database file.

    3. Does myBase use a lot of hard disk space?

      myBase doesn't use any more disk space than its binary package. You'll need enough disk space to store your own database files. myBase provides a set of utilities for database maintenance, such as the integrated zip utility, 'Empty Recycle Bin' and 'Optimize for file size' etc. All these efforts help make databases compact and save disk space.

    4. Does myBase lock users data? Once data saved in myBase are they always myBased?

      No. myBase doesn't lock any users data in it, you have the convenience of exporting/mapping all your data as a directory tree in the file system at any time.

    5. What is an appropriate size for an individual database (.nyf files)?

      myBase 7.x integrates the 64-bit storage library (SSG-5), and a single .nyf database size can be extended up to 8EiB in theory, so you can make your database size as large as you see fit. However, you may want to keep your database size smaller for the convenience of backing up, syncing and/or transferring your database over network. myBase provides the Shortcuts and Hyperlinks and Relative path features which can help maintain your database size reasonable,

    6. Is it possible to run myBase Desktop from on a USB stick?

      Basically myBase Desktop works from in any accessible directory in local file system, including removable disk drives (e.g. USB sticks). You may want to put myBase program files into a removable disk drive, and also put your .nyf database files on it, and then run your database smoothly with myBase from the removable disk drive. However, for safety and stability considerations, it's not recommended to open .nyf databases for editing from within a removable disk drive, in case of any potential USB I/O problems with the removable disk that may cause damage to the working databases. If you have to do so, please be sure to preserve backups of your .nyf databases. This caution also applies to using myBase from in shared folders (SMB/NetBIOS) over LAN.

    7. How do I register (unlock, activate) my copies of myBase with my license keys?

      Registering myBase Desktop

      • Select the "Help/Register..." menu item;
      • Enter your registration name in the 'User name' field;
      • Enter your license key codes in the 'License key' field;
      • Press 'OK' button to save the license key;

      Having problems registering?

      • In case of typos, it's recommended that you copy/paste license key codes, instead of typing them in manually;
      • A license key consists of 2-line codes, please be sure to copy/paste both lines exactly.
    8. What type of files/documens will be indexed and searchable?

      myBase invokes the associated file filters installed on the system to parse relevant documents.

      For Linux/MacOSX, myBase provides inbuilt file filters for HTML/TXT/RTF documents;

      For Windows, myBase invokes Windows IFilters installed on the system to parse documents based on the file extension names. The IFilters for MS-Office and HTML documents are integrated within Windows 2000+; For other type of documents (e.g. PDF) to be searchable, you'd need to install the relevant IFilters provided by manufactories.

      Once a new IFilter is installed, you'd need to clear and rebuild the index data for the relevant documents to be re-indexed.

      For example, in order to make .PDF documents searchable, you'd need to install Acrobat Reader or any of available PDF IFilters and then re-build up indexes.

    9. .

      .

  13. Howtos

    1. How to apply relative file paths to shortcuts/hyperlinks?

      myBase supports the 'Relative path' feature, which allows to create links to local files with relative path. To use relative path, you'll need to first put documents into the directory where the current .nyf database file resides, and then insert the documents into myBase as hyperlinks or shortcuts, the 'relative path' is automatically applied. When triggering the hyperlinks/shortcuts, the relative path is evaluated.

      The 'Relative path' feature helps maintain the consistency between .nyf database and linked documents, and keep shortcuts/hyperlinks functional even after they're moved together to elsewhere.

    2. How to rename an info item?

      To rename an info item, simply press F2, or click twice (i.e. click and then click, rather than a double-click) on the info item, or select the 'Edit - Edit/Rename' menu item, then the item title goes into edit mode, whereby you can edit the title text.

      In addition, you can also copy the currently selected text from within the content to item title. To do so, please first select a text in the item content, and then select the 'Edit - Copy text to title' menu item.

    3. How to customize default formatting for HTML content

      When adding new info items, item content will be initialized with the default formatting (font/size/color...). To customize the default text formatting, please select the 'View - Options' menu item, under the 'Edit' tab, you can change the default text formatting.

      Note that the default text formatting only applies to new info items added thereafter, but not affect any content in the existing info items.

    4. How to multi-select info items?

      Within myBase 7.x, the outline view supports multi-selecting. To have multiple info items selected, please use Ctrl+Click or Shift+Click, i.e. hold down the Ctrl (or Shift) key as a modifier while clicking on info items by mouse.

    5. How to customize the keyboard shortcuts?

      To customize keyboard shortcuts for a menu item, please select the 'View - Options' menu item, then click the 'Keyboard' tab, and find/filter the command item in the list, and then simply hit a combination/function key on the command item.

    6. How to undelete attachments or info items?

      Please select the 'File - Maintenance - Undelete Items' menu item, in the 'Undelete items' popup window, all info items including trashed items are listed in a tree view, whereby you can choose to undelete info items or attachments.

    7. .

      .

  14. Tips

    1. Exporting current branch and produce a new .nyf database file

      Select the 'Share - Export branch to .nyf file' menu item, you'll need to determine a destination .nyf file name and path.

    2. Importing a branch from another .nyf database

      Select the 'Share - Import data from .nyf file' menu item, then select a .nyf file, and choose a branch to import.

    3. An easy way to open a database as Readonly

      When you open a database from either in the 'Recently used databases' menu or the file system, with the [Ctrl] key held down, the database will open as Readonly. In fact, the [Ctrl] key toggles the 'Readonly' mode when opening a database;

    4. Behaviour on pressing the Tab or Shift+Tab key in HTML editor.

      The behaviour on pressing the Tab key in the HTML editor depends on the current selection.

      If there's no text currently selected, pressing Tab simply inserts a Tab character, (by default, 8 blank spaces are inserted at caret, and you can choose an alternative characters or HTML entity in the Options dialog box), while Shift+Tab simply moves input focus backwards to the outline or label views.

      If the selection is not empty, pressing Tab triggers the 'Indent' operation to increase indentation for the selected content, while Shift+Tab decreases indentation.

    5. .

      .
  15. Notes

    1. Notes on safely running myBase database

      As database software developers, we're definitely aware of importance of data safety. In our opinion, it's even the most important thing for a database software, We've spent so much time on improving the program for safety, stability and reliability; The latest version of myBase has integarted the new 64-bit storage library (SSG-5), that has made a big progress on data stability and reliability. Here are a few notes/tips that may help you run myBase software safely.

      • It's highly recommended to create backup for your .nyf database periodically;
      • Be sure to have working databases normally closed before the OS system shuts down or goes into hibernation;
      • Editing .nyf databases from in shared folders (SMB/NetBIOS) over LAN with myBase Desktop is NOT recommended. Accidental failure on your network connection may damage the working .nyf databases. However, viewing .nyf databases via file sharing over LAN is a good idea.
      • myBase Desktop can run from on a removable disk drive (e.g. USB stick); However, it's not recommended to open .nyf databases for editing from on a removable disk drive, accidentally/unsafely unpluging the removable disk may cause file corruption. If you have to do so, please be sure to first create backup;
      • If you have a system tweaking utility (e.g. Anti-virus, Cleaner) running in background, it's recommended to temporarily deactivate it while myBase runs, or put myBase on the 'Exception' list, especially when you experienced problems with it;
      • It's safer if you have working databases closed in the case that you won't work with them any more in a day, instead of just leave them running in background;
      • It's safer if you open a dataase as Readonly in the case that you don't want to edit it.
      • When a database is open in edit mode, system crashes or power failure may cause file corruption.
      • If you're having problems opening a .nyf database, and there's neither a recent backup nor any other choice, please try using the recovery tool.
    2. About the file extension names (.nyf, .bak, .dbindex)

      • The .nyf file contains titles, notes, webpages, images, attachments, everything of a database.
      • The .bak file is backup of the .nyf database having the same file name.
      • The .dbindex file contains index data created for fast searching.
    3. What's the difference between Attachments and Shortcuts within myBase?

      When you insert a file as attachment, the whole file is copied into the database, and the database file size usually gets larger. When you insert a file as shortcut, only a file link is inserted into the database, rather than copying the whole file, it won't bloat the database file. If you have a number of (larger) files need to organize within myBase, it's recommended to insert them as shortcuts with the relative path applied.

    4. Upgrading exisitng .nyf databases to Ver 7.x

      For better cross-platform support, myBase Desktop 7.x has upgraded its storage and text content format; If you have a .nyf database created within old versions of myBase (e.g. 4.x, 5.x, 6.x) for Windows, and would like to get it to work with myBase 7.x, please follow this,

      • Download and install myBase Desktop 6.5.1+ on a Windows PC;
      • Open the .nyf database within myBase Desktop 6.5.1+;
      • Select the [File - Maintenance - Replicate from RTF to HTML ...] menu item, specify a new database file name, and press OK button;
      • After the replication/conversion is done, the new replication .nyf database will work with myBase Desktop 7.x on both Linux, Mac OS X and Windows;

      Unlike RTF text formatting, the HTML format doesn't support OLE objects embedding into text contents, OLE embedding is a Windows OS specific feature that is currently not available for Linux/Mac OS X. The replication tool tries to convert OLE objects (if any) into thumbnail images embedded in resulting HTML content.

      Within v6.5.1+ the inbuilt RTF2HTML conversion during replication only parses a subset of RTF/1.8 control words (e.g. font, style, size, color, alignment, indentation, spacing, picture, etc.), not all RTF control words will be exactly converted. HTML formatting is quite different than RTF, you'd need to perform some adjustments manually, and have old .nyf databases preserved for later reference.

      If you have MS-Word properly installed on the system, it's recommended that you choose MS-Word for RTF2HTML conersion during the database replication. MS-Word fully understands the RTF specifications and performs almost perfect RTF2HTML conversion. myBase 6.5.1+ provides the option allowing to invoke MS-Word for RTF2HTML conversion while replicating databases.

    5. Opening attachments externally with associated programs

      When you open attached documents (i.e. attachments, not shortcuts) with associated programs, the attachment must be extracted and saved into a temporary directory, whereby external programs can access to them. myBase keeps an eye on the externally working documents, and tries to update the database if any changes are made to the documents, but this operation only performs when committing changes to the database, as myBase doesn't accurately detect if the documents have been closed by associated programs during the period. myBase only cleans up the temporary files at exit; If a document is opened with an external program, it remains in the temporary directory til myBase exits. You will need to actively have the externally working documents closed as soon as you finished editing the documents, and also note that:

      • If you close a database without precedingly closing the externally working documents, the changes made to the temporary doucments will be discarded;
      • If you re-open a document which is still opened externally, it may fail, or make conflicts with different revisions, that depends on behaviour of the associated programs;
      • If you re-open a document which has normally been closed since last open, myBase is unsure of the status, so you may be prompted with a message: "The attachment file might have been opened previously. Re-open it anyway?"; Press Yes button to open it again if you're sure that the document has been closed previously.
    6. Disk space usage with myBase

      By default, all information is automatically compressed with the integrated zip utility and saved in .nyf databases. In most of cases, you don't need to care about the disk space usage on myBase databases. Here are a few notes about disk space usage that may help you understand how myBase stores information, and how to run it smoothly and safely.

      • Deleting info items or attachments only marks them as removed (trashes in the Recycle bin), this way, you have the chance of recovering them when you want them back; That's to say, deleting (trashing) info items or attachments won't free up any disk space, and the .nyf database file size will not shrink, till you run the [File - Maintenance - Empty recycle bin/Optimize for size] utility.
      • Committing changes to item's HTML content trashes the current content and produces a new entry in the revision history. You can choose to revert to one of existing revisions, till you run the [File - Maintenance - Empty recycle bin/Optimize for size] utility.
      • Inserting files as attachments copies whole file content into the .nyf database, this may bloat the .nyf database file size. If you'd like to organize a large number of documents with myBase, it's recommended that you just add the documents as shortcuts or hyperlinks, instead of adding attachments; Shortcuts/hyperlinks will not use too much disk space. In addition, myBase provides the Relatve path feature, which helps maintain consistency between shortcuts/hyperlinks and linked documents.
    7. .

      .

  16. Troubleshooting

    1. Why are all editing tools grayed out? I cannot edit anymore.

      If the database was open as Readonly, please try to close and re-open it without the 'Readonly' attribute. To do so, select the 'File - Open Database...' menu item with the Ctrl key held down, locate the target database file and press the 'Open' button.

      Note that current text note can be temporarily set as Readonly by selecting the 'Edit - Edit/Rename' menu item. If this is the case, simply select the menu item again to remove the 'Readonly' flag.

    2. Nothing found when searching a database.

      The [Advanced search] and [Find as you type] utilities are based on index data. Before searching, you'll need to build/update index data by selecing the [File - Maintenance - Update index] menu item. Without index data, you'd want to try the [Find partial words] and/or [Use regular expression] option.

      In addition, myBase provides the [Tools - Diagnose file parser] utility, which is intended for diagnose index data and search results by parsing HTML content or attached documents.

    3. Password forgotten?

      Please be sure to save your passwords in a secure place after setting passwords to protect your databases. If you lost your passwords, you might have lost access to your database, we suggest that you try to first list out all possible passwords you ever used on the computer, and then try them one by one.

    4. Failure loading a database?

      If you're having problems opening a .nyf database within v6.3.x/7.x, please make sure that you have the appropriate rights accessing to the .nyf file, or find solutions below by error messages;

      "Failed to open the database ..."
      If you experienced an error message like this: 'Failed to open the database...', it's more likely that the database is already open within another myBase instance. If this is the case, you can simply activate the previous myBase instance. Otherwise, the .nyf file could be in use by some other programs in the system, for example, certain Anti-virus/malware utility might be running in background and actively checking it at that time.
      "The database has a signature of the storage library (SSG-3) ..."
      When you attempt to open a .nyf database created with old versions of myBase (e.g. 4.x, 5.x, 6.x), it may fail to open with a popup message like this: "The database has a signature of the storage library (SSG-3) which is no longer supported in the new cross-platform system". As indicated, myBase Desktop 7.x does no longer support the old version of storage library (SSG-3), you'll need to upgrade the .nyf database with the new SSG-5 storage library. In order to upgrade the storage, please try this;
      • Download and install myBase Desktop 6.5.1+ on a Windows PC;
      • Open the .nyf database within myBase Desktop 6.5.1+;
      • Select the [File - Maintenance - Replicate from RTF to HTML ...] menu item, determine a new database file name, and press OK button;
      • After the replication/conversion is done, the new replication .nyf database will work with myBase Desktop 7.x for both GNU/Linux, Mac OS X and Windows.
      "Invalid file identifier detected ..."
      If you're sure that the file has the .nyf extension name, and worked ever before with myBase Desktop, it might have got corrupted somehow, you'd need to restore the database from the most recent backup file. To restore the database from a backup file, simply change the file extension name to .nyf, or duplicate the .bak file as a new .nyf file, then you can load the new .nyf file within myBase. Otherwise, if you don't have any backup files preserved, you'd have to try running the recovery tool shipped within the SSG Command Line Tools package. To recover data from a corrupted .nyf file, please try to first download and extract the package, then open a Terminal window, and change to the directory where the command 'ssg5recover' resides, and then run the command: ssg5recover "full-path-to-nyf-file" [More info]
      "Authentication method not supported ..."
      When you see the error message: 'Authentication method not supported ...', you'd need to run this utility (SSG-5 Storage Replicator) and replicate the database (.nyf files) to a new storage file, that will have the new authentication method enabled. The new authentication algorithm is based on SHA-256 without encryption.
    5. .

      .