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, you'd need to create a new .nyf database at first by selecting the [File - New database] menu item, then you can add info items within the outline view, input text in the HTML editor, insert files into info items as attachments, and selectively 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, the 'Create new database' dialog box pops up, whereby you can determine the target .nyf database file path and set a password for data security.

    2. Adding info items

      The new database is automatically open when created. Now you can insert some new info items in the outline tree view by selecting the [Outline - New child item] or [New sibling...] menu items. Each info item accepts a rich text as default note. Clicking on an info item within the outline view, its default text note will open in the rich editor, whereby you can edit or format the text 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 an original file on disk or URL (web resource). 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 implements additional organizing methods, such as item links, symbolic links, linking with calendar, and labeling etc.

    1. Moving info items

      Info items can be moved up/down by selecting the [Outline - Move item up/down...] menu item; and can be moved to another info item, by selecting the [Outline - Move to ...] menu item.

    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 jump and open it up. To have an item linked with another one, please select the [Outline - Link info item] menu item, the [Browse outline] window appears whereby you can select a target item to make an item link.

      The item links can also be inserted into HTML notes as hyperlinks, so one can click on the hyperlinks to open the target items. To insert an item link into HTML notes, right-click on a highlighted text within an HTML note, select the 'Edit hyperlink ...' menu item, then press 'Info Item' button so you can select a target info item to link;

    3. Symbolic linking

      Symbolic links 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, shortcut, clone-node, 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, 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 [Outline - Symbolic link] menu item, then specify the target info item to link.

    4. Each info items can be linked with a calendar date by selecting the [Outline - Link calendar] menu item. By default, the associated calendar date will be displayed in title text in the outline tree. The calendar date attributes can be combined into queries when searching databases.

    5. Labeling info items

      In addition to the basic tree structured outline, the label tree provides the second method for categorizing info items and supports unlimited hierarchical labels. To label an info item, please select the [Outline - Label info item] menu item, the [Browse label tree] window pops up, wherby you can select and check one or more appropriate labels to label 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 items] or [Add sibling ...] menu item within the label list view;

    6. Defining bookmarks

      myBase supports defining bookmarks inside HTML content of an info item or attachment; To define a bookmark inside an item item, please first open the info item and highlight the target text in the HTML content, then select 'Bookmarks - Add to bookmarks' menu item.

      Note that myBase inserts an Anchor into the HTML content as a bookmarked position, so it can scroll down the HTML content to the bookmarked position when triggering the bookmark item.

    7. Using custom icons

      Each .nyf database can store a collection of bmp/png/jpg/gif image files (16*16) as custom icons, which can be applied to info items and label items. The custom icons are displayed in front of the title text of associated items within the outline view. Before assigning icons to items, you'd need to first insert some 16*16 bmp/png/jpg/gif files into the database as custom icons, and then the imported icons can be applied to info items or label items. To insert image files as icons, please select the [Outline - Custom icons] menu item, the [Custom icons] window pops up, wherby you can press the [Add] button to insert image file as custom icons; To apply icons, double click on a desired icon, or select an icon and press the [Apply] button.

    8. Sorting items

      Info items or label items can be sorted by title text 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 open up the outline view and select the [Organize - Sort child items] menu item. To sort sub labels, please open up the labels view and select the [Organize - Sort child items] menu item.

  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. from 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 API Reference.

    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 item content.

      To import files as attachments, please select the [Capture - Import directory tree - as attachments] 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 try using the [Capture - Import directory tree - as hyperlinks] menu item, that imports the directory tree structure with files inserted as hyperlinks, instead of copying whole files into the database storage; It inserts file info including path, size and date modified attributes into item content. Clicking on the hyperlinks launches the original files so long as they're associated with a program 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 data from an existing .nyf database, please select the [Capture - Import branch from .nyf database] menu item, then select a .nyf file, the [Browse outline] dialog box appears, whereby you can select an info item (branch) to import.

    3. Importing files as child items

      This utility imports files as child info items, each file creates an info item under the current item, HTML files are inserted as item's default content, while other files as attachments. When importing local HTML documents, accompanying images if available 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 converts .doc documents into HTML documents and save as item's default content, it requires MS-Word to be properly installed on the system for the document format conversion.

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

    5. Importing MS-Word outline

      This utility imports an MS-Word document with outline items stored 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. This utility requires MS-Word to be properly installed on the system for the conversion.

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

    6. 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, then select a .opml file to import.

    7. Capturing webpages/snippets

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

      If you'd want to capture and save webpages (or snippets) directly from within a 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 simply right-click on a webpage and select the [Save with myBase] menu item to capture and save the whole webpage or highlighted snippets including accompanying images within the currently working myBase database.

      You'd need to first launch myBase and open a database, and then instruct WebCollect to transfer the captured webpage/snippet to the currently working database.

    8. Importing text by delimiter

      This utility imports text content as child items, from a text file with text lines 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 delimiter.

      To import the text file as child items, please select the [Capture - Import text by delimiter] menu item, then select a file containing text lines, and specify the delimiter used to split the text lines. If you'd want to import a text file with each text line saved as a child item, simply supply the '\n' as delimiter.

    9. Clipboard Monitor

      myBase provides the clipboard utility which helps capture info from other programs by monitoring the system clipboard. Once the clipboard monitor is activated, any changes on the clipboard would trigger a popup window, whereby you can confirm to save content within the currently working database.

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

      Note that Mac 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 contents to clipboard, or simply drag contents and drop onto the icon to trigger it.

  6. Sharing data in various formats

    1. Exporting directory tree

      This utility maps the outline items 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 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 create the directory tree.

    2. Exporting HTML tree

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

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

    3. Exporting current branch to a .nyf file

      This utility exports a outline branch (including item content and sub items) as a .nyf database file.

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

      Note that if you choose a target database that already exists, you'll be prompted to select a destination outline item. Otherwise, it creates a new .nyf file to save the contents.

    4. Exporting selected attachments to a folder

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

      To export selected attachments, please select the [Attachment - 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 files as attachments 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 by utilizing OLE-Automation. It's useful for writters/researchers to export content and keep the hierarchical outline as original within MS-Word.

      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.

      Note that it's OLE-Automation based (a Windows platform feature), so you'll need to first have MS-Word properly installed on the system for this utility to function normally.

    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 then be compiled into CHM ebooks, by utilizing Microsoft HTML Help Workshop.

      You can select to export content in either current branch or whole database, and 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 manually invoking the CHM compiler.

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

  7. Database maintenance

    1. Setting password for data security

      It's recommended to set a password as soon as you create a database. Note that the database password is unchangeable once it's been set. If in the case that you'd have to change a database password, please consider to replicate the entire database into a new database, by selecting the 'File - Maintenance - Replicate database ...' menu item, that allows you to set a different password for the new database.

    2. Undeleting info items and files

      Modifying a text note trashes the previous revision into the recycle bin, and sets the new one as current; Deleting an info item (branch) also trashes it into the recycle bin. This way, we get a chance to undelete and retrieve them if needed. To undelete trashed entries, please select the [File - Maintenance - Undelete items] menu item, a popup window appears, whereby you can select trashed entries to undelete.

    3. Optimizing 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, the inbuilt zip utility automatically compresses every entries though. If you'd want to optimize database for size, please select the [File - Maintenance - Empty recyle bin] menu item first 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

      Creating backup for important databases is always highly recommended. 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 create backups by simply copying the .nyf files from within file system.

    5. Replicate Database

      The [File - Maintenance - Replicate database...] utility helps replicate whole content of the current database to a new one that can be initialized with a different password. The generated database is automactically done with size optimization, so it is useful as well when you want to eliminate space fragmentation from a database and make the database file size compact.

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

    1. Indexing databases

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

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

      Note that it's index-based, 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) in search phrases. You can type a search phrase like this: w1 AND w2 OR w3 OR w4 NOT w5. For the boolean operators (AND, OR, NOT), they 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 a blank space must be added after each boolean operators, otherwise the operators are skiped.

    4. myBase also implemented the [Use regular expression] feature, which matches regular expressions you input. Select the [Search - Advanced search] menu item, then enter a regular expression (only pattern string, like this: wj{1,}soft\.com), results if any will be listed in the query results window.

      Note that this feature doesn't require index data, it simply scans content of the database in the scope.

    5. Find in text

      This utility looks into the current note text for words you input, it behaves like the 'Find' command in Windows Notepad, select the 'Edit - Find in Text ...' menu item, then type in a word and press the 'Find Next' button, the next match occurrence will be highlighted.

    6. List recently modified entries

      This utility scans the whole database for the entries (info items, notes, attachments and shortcuts) modified within a specified date period, e.g. today, this week, last week, this month, etc... To list recently modified entries, please select the [Search - List recently modified entries ...] menu item, then select a date period from within the dropdown list to search with.

      Note that this utility doesn't require index data, it traverses the outline tree and looks at timestamp of each entries.

    7. This utility scans the specified disk directory tree for words or Regular Expressions you input. You can select to search file names only, or file content, or both. When you select to search file content, it attempts to parse documents by utilizing the corresponding IFilters installed on Windows system. As it takes too much time to parse all the documents in a query, this plugin maintains an internal .nyf database to cache the file content, so lately searching the documents may get faster. The cache database is located in your home directory.

      Note that this utility doesn't maintain an index database internally, it 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 target files.

  9. 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 on a USB stick?

      Basically myBase Desktop works from within 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 those shared folders 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 always recommended that you copy/paste license key codes, instead of typing them manually;
      • The license key consists of 2-line codes, so please be sure to input the both lines exactly.
    8. What type of files/documens will be indexed and searchable?

      myBase requires appropriate file parsers to parse documents, and then build indexes for the documents. For Linux/MacOSX, myBase provides inbuilt file parsers for HTML/TXT/RTF documents; For Windows, myBase attempts to parse documents according to file extension names by utilizing Windows IFilters installed on the system. 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 corresponding IFilters provided by manufactories. After 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. .

      .

  10. Howtos

    1. How to save disk space with myBase databases?

      In order to save disk space, 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. Although, there're still a few tips that may help save disk space, and make myBase run smoothly and safely.

      • When you delete an info item or an attachment, it's only marked as removed (junk), so that you have the chance of recovering them in the case that you'd want them back later, or want info items' content to revert to one of history revisions. That's to say, deleting info items or attachments doesn't free up any disk space, and the .nyf database file size does not shrink. If you'd like to purge the junk, and make the .nyf databases compact and save disk space, please try performing the operations 'File - Maintenance - Empty recycle bin' and then ' Optimize for size'.
      • In order to organize a large number of documents and help save disk space, it's recommended to insert the documents as shortcuts or hyperlinks, instead of insert attachments. myBase provides the Relatve path feature, which helps manage the shortcuts/hyperlinks (pointers to local files).
    2. How to apply relative file paths to shortcuts/hyperlinks?

      myBase supports the 'Relative path' feature, which allows to create links to local files by relative path. To do so, 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 the .nyf database and the linked documents, and keep the links functional even after they're moved together to elsewhere.

    3. 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 the item title. To do so, please first select a text in the text content, then select the 'Edit - Copy text to title' menu item.

    4. 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, in the 'options' dialog box, you can change the default text formatting under the 'Edit' tab.

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

    5. 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.

    6. 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.

    7. 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.

    8. .

      .

  11. 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.

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

      Within the HTML editor, the behaviour on pressing the Tab key depends on the current selection. If there're 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. However, if the current selection is not empty, pressing Tab switches to trigger the 'Indent' operation, and increase indentation for the selected content, while Shift+Tab decrease the indentation.

    5. .

      .
  12. Notes

    1. Any suggestions 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 spent 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. Although there're still a couple of notes/tips for you to run myBase database 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 a .nyf database over LAN via file sharing with myBase Desktop is NOT recommended. Accidental problems with your network connection may damage the working .nyf databases. Well, viewing .nyf databases via file sharing over LAN is a good idea.
      • It's recommended to have working databases closed if you won't work with them any more in a day, rather than just leave them running in background;
      • If you don't intend to edit a database, it's recommended to open it as 'Readonly'. Opening a database as Readonly prevents any changes to it, and protects it from being modified accidentally by other programs;
      • When a database is open in edit mode, system crashes or power failure may damage the currently working databases. If a database got corrupt, you'd need to recover data from a recent backup;
      • myBase Desktop can run from on a removable disk drive (e.g. a USB stick); However, it's not recommended to open .nyf databases in edit mode directly from on a removable disk drive, as accidentally/unsafely unpluging the removable disk may damage the currently working databases. If you have to do so, please be sure to first create backup for your databases;
      • If you're running a system tweaking utility (e.g. Anti-virus) 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;
      • myBase provides the 'Tray Icon' option, which allows the database program to minimize and standby as an icon on the system tray. However, if you won't work with a database for a long time in a day, we suggest that you have the working databases closed and then minimize the program window, in case of any accidental system crashes.
      • If you're having problems opening a .nyf database, and there's neither a recent backup nor any other choice, please try using the comand line tool (ssg5recover) to recover data from a corrupted .nyf database file. For more info about the command line tools, please visit Wjjsoft Structured Storage Library.
    2. About the file extension names (.nyf, .bak, .ssgindex, .dbindex)

      • The .nyf file contains titles, notes, webpages, images, attachments, everything of a myBase database.
      • The .dbindex file contains index data created for each .nyf database to enable the Fast-Find feature.
    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 built up with 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 specific feature that is currently not available for Linux/Mac. The replication tool tries to convert OLE objects (if any) into thumbnail images embedded in the resulting HTML contents.

      Note that 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.

      Nevertheless, 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 during database replication for upgrading.

    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 doucments may lose;
      • If you re-open a document which is still opened externally, it may fail, or make conflicts on the differnet revisions, that depends on behaviour of the associated programs;
      • If you re-open a document which has normally been closed since last opens, 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?";
    6. .

      .

  13. 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. .

      .