Skip to content
Jdogzz edited this page Nov 28, 2021 · 17 revisions

Main window view

Main window picture Top row: Menu options

Next row: Buttons and search bar

Left window pane: Note header, Note title, Note content

File menu

File menu picture

New note

Keyboard shortcut: Ctrl-N

This option opens the New entry dialog box for creating a new note. This note is inserted numerically next in the note database regardless of what note is displayed at the time the new note is added.

New note sequence

Keyboard shortcut: Ctrl-I

This option behaves identically to the New note (Ctrl-N) option. One additional operation is performed: In the main window, when a given note is open, calling the New note sequence operation will then save the newly made note in the note sequence tree of the note open at the time.

Quick note

Keyboard shortcut: Ctrl-Alt-N

This option immediately creates a new note at the end of the line up with autogenerated note content (using whatever is on the clipboard at the time of creation), and sets the main window interface to the newly created note view. If data that is not text is found on the clipboard, the quick note function will silently fail to do anything. See Issue 399.

Quick note with title

Keyboard shortcut: Ctrl-Shift-N

This option appears to operate identically to the Quick note (Ctrl-Alt-N) function. This may be a bug. See Issue 399.

Open

Keyboard shortcut: Ctrl-O

This option prompts the user to select another ZKN3 database file for opening in the interface. Because this switches databases, it will prompt the user to save any pending changes in the currently opened database before opening the newly selected one.

Recent files

This option provides a list of recently opened ZKN3 databases from which the user may select a file for opening.

Save

Keyboard shortcut: Ctrl-S

This option saves the currently opened database to disk. If the database was newly created, this will prompt the user for a file location to which it may be saved.

Save as

Keyboard shortcut: Ctrl-Shift-S

This option creates a copy of the currently opened database and prompts the user for a file location to which it may be saved. Afterwards, the program is set to use the newly made database file.

Create new outliner

This option creates a new Outliner and prompts the user for the new outline's name. If an outline is already open, after providing the new outline name the outliner window will switch to the new outline view.

Create new file

This option creates a new Zettelkasten database file. It will instantly switch to an empty interface, and will not allow the new database file to be saved until adding a change that needs to be saved.

Import

File import picture

Keyboard shortcut: Ctrl-Shift-I

This option allows for importing notes from files. Different file types are available for import:

File import types picture

Export

Keyboard shortcut: Ctrl-Shift-E

This option allows for exporting notes to files. The user first receives a prompt asking whether to export all notes or selected notes given by numerical value.

Information

File information picture

This displays various statistics about the currently opened database file, the file's location, as well as allowing the user to set the folders for attachments and images.

Quit

Keyboard shortcut: Ctrl-Q

This will exit the program. If there is unsaved data, the user will be given a prompt as to whether or not they want to save the changes.

Edit menu

Edit menu picture

Edit note

Keyboard shortcut: Ctrl-E

This will bring up the Note entry window for the note currently displayed in the main window.

Remove note

Keyboard shortcut: Ctrl-Shift-Delete

This will bring up a prompt asking the user if they would like to delete the note currently displayed in the main window. Afterward the main window will display the numerically next note if available.

Remove keyword

This will bring up a prompt asking the user if they would like to delete the keyword currently selected from the note currently displayed in the main window. Note that the same functionality is available using the Delete key.

Copy

Keyboard shortcut: Ctrl-C

Copy (plain text)

Keyboard shortcut: Ctrl-Shift-C

Paste

Keyboard shortcut: Ctrl-V

Select all

Keyboard shortcut: Ctrl-A

Add text selection to keywords

Keyboard shortcut: Ctrl-Shift-K

This option adds any text that is selected in the note area of the main window, including note header, title, and content, to the keywords of the currently displayed note in the main window. Any special formatting or line breaks are stripped out for the keyword addition.

Set first line as title

Keyboard shortcut: Ctrl-Shift-U

This option sets the first line of text in the note content as the title of the currently displayed note in the main window. If a title already exists, it will be overwritten by the first line of text. Any special formatting will be stripped out for the title addition.

Set selection as title

Keyboard shortcut: Ctrl-Alt-U

This option sets the first line of text in the note content as the title of the currently displayed note in the main window. If a title already exists, it will be overwritten by the first line of text. Any special formatting or line breaks will be stripped out for the title addition.

Insert cross reference

Keyboard shortcut: Ctrl-Alt-L

This option brings up a prompt for the user to enter the numbers of notes to add as cross references. These then appear in the note header and Links areas. If deleted notes are included in the range given to the prompt, a warning will alert the user that this is the case but will still include the numbers in the cross references.

Insert note sequences

Keyboard shortcut: Ctrl-Alt-I

This option brings up a prompt for the user to enter the numbers of notes to add as sequences. Each note will be shown as top level sequences, not with each note including nesting at a lower level from the preceding note. In the example shown below, notes 4,10-12 were submitted with Ctrl-Alt-I:

Edit menu insert note sequences picture

Add bookmark

Edit menu add bookmark picture

Keyboard shortcut: Ctrl-B

This option brings up a prompt to add the currently displayed note in the main window to the bookmark list. This may be done once per note. The user will be given the ability to choose existing categories from a dropdown or add a new category which may then be selected. A comment may be added in the prompt for the bookmark.

Add to outliner

Keyboard shortcut: F9

This option adds the current note to an outliner-only clipboard and brings up the outliner, prompting the user to first select a location from the outline tree and then the paste function (Ctrl-V) may be called to insert the note.

Find menu

Find menu picture

Find

Find menu find picture

This option allows the user to search through the note database (it will not search outline-only content). The search will bring up the results in a new window.

Replace

Find menu replace picture

This option allows the user to search through the note database to replace expressions (it will not search outline-only content). It will give a notification of the statistics of the replacement.

Notes

Find menu notes picture

This option allows the user to search through the note database according to the criteria selected. The search will bring up the results in a new window.

Note keywords

Find menu notes picture

After selecting a keyword(s) from the note currently displayed in the main window, this option allows the user to search through the note database according to the criteria selected. The search will bring up the results in a new window.

Note navigation

Goto first note Keyboard shortcut: Ctrl-Shift-Minus

Goto previous note Keyboard shortcut: Ctrl-Minus

Displays the next note Keyboard shortcut: Ctrl-Plus

Goto last note Keyboard shortcut: Ctrl-Shift-Plus

Show random note Keyboard shortcut: Ctrl-Number Sign

Show next note in history Keyboard shortcut: Alt-Left

Show previous note in history Keyboard shortcut: Alt-Right

Goto note Keyboard shortcut: Ctrl-G (This one places the cursor in the note number box of the main window for user entry)

View menu

View menu

Main window tab focus

Links Keyboard shortcut: Ctrl-F1

Note sequences Keyboard shortcut: Ctrl-F2

Keywords Keyboard shortcut: Ctrl-F3

Authors Keyboard shortcut: Ctrl-F4

Titles Keyboard shortcut: Ctrl-F5

Keyword-Cluster Keyboard shortcut: Ctrl-F6

Bookmarks Keyboard shortcut: Ctrl-F7

Attachments Keyboard shortcut: Ctrl-F8

Display current note

When a note is overlayed but not fully displayed, as when following a note in a note sequence with a single click, then this option will remove the overlay and again display the original note.

Highlighting in main window

Highlight keywords

Keyboard shortcut: F7

This seems to not do anything. This may be a bug. See Issue 401.

Highlight coded paragraphs

When text is associated with a keyword, this option when toggled on will highlight the text in the main window note content view when the corresponding keyword is selected from the list. This may glitch and not allow disabling of the highlighting until the program is restarted. See Issue 401.

Window menu

Window menu

Only one of each window type can be open at a given time.

Bringing up windows

Searchresults Keyboard shortcut: F3

Outliner Keyboard shortcut: F4

Edit window Keyboard shortcut: F11 (Note that this window for editing a note must first be opened and in the background/minimized in order for this function to work)

Zettelkasten menu

Zettelkasten menu

Links menu

Links menu

Currently this menu only appears when a keyword-based link is included in a note. This may be a bug. See Issue 404.

Note sequences menu

Note sequences menu

This menu appears at the end of the list of menus when the Note Sequences tab of the main window is active.

Remove

When selecting a non-top-level item in a note sequence tree, this option is available and will allow the user to remove the branch and all sub-levels branching from it.

Add cross reference

When selecting a non-top-level item in a note sequence tree, this option is available and will allow the user to add the note selected as a cross reference in the original note's header.

Add bookmarks

When selecting a non-top-level item in a note sequence tree, this option is available and will allow the user to add the note selected as a bookmark. As a bookmark can only be added once to the bookmarks list, if the selected note is chosen to be added to the bookmarks but already exists as a bookmark, the addition will not change the preexisting bookmark neither in category nor in comment.

Add to outliner

When selecting a non-top-level item in a note sequence tree, this option is available and will allow the user to add the note selected to the outliner. A prompt will ask the user to select the location at which the note should be inserted.

Find origins of note sequences

This option will bring up the search results for notes which serve as top-level notes in a note sequence.

Export

This option will bring up a prompt for the export of the selected note and all sub-level notes.

Export as search results

This option will bring up the search results containing the selected note and all sub-level notes.

Show note numbers

This option will toggle the display of note numbers in the note sequence tree.

Visible levels

This option allows for the setting of whether to display all note sequence levels or truncate it to within a range of 1 to 5 levels.

Keywords menu

Keywords menu

This menu appears at the end of the list of menus when the Keywords tab of the main window is active.

Authors menu

Authors menu

This menu appears at the end of the list of menus when the Authors tab of the main window is active.

Titles menu

Titles menu

This menu appears at the end of the list of menus when the Titles tab of the main window is active.

Cluster menu

Cluster menu

This menu appears at the end of the list of menus when the Cluster tab of the main window is active.

Bookmarks menu

Bookmarks menu

This menu appears at the end of the list of menus when the Bookmarks tab of the main window is active.

Attachments menu

Attachments menu

This menu appears at the end of the list of menus when the Attachments tab of the main window is active.

Buttons bar

Buttons bar

Notes pane

Notes pane

Keywords pane

Keywords pane

Links tab

Links tab

The upper pane shows links based on keyword overlap. When nonzero, the percentage of keywords of the note currently displayed in the main window that are found in every other note in the database is calculated and displayed as the Relevance metric. These links are made automatically by the program.

The lower pane shows explicit cross reference links made by the user. It does not include note sequence connections.

Note sequences tab

Note sequences tab

Keywords tab

Keywords tab

Authors tab

Authors tab

Titles tab

Titles tab

Cluster tab

Cluster tab

This area shows how keywords from all notes in the database intersect, regardless of which note is currently displayed in the main window. Every keyword is shown as a top level entry, and below it are all keywords ever present in the same note with the selected keyword. To work only with keywords present in the note currently displayed in the main window, there is a toggle at the bottom of the Cluster tab. This seems to be glitched with showing duplicate top-level entries. See Issue 405.

Currently it seems this is not automatically repopulated when new keywords are added, and needs to be manually repopulated by restarting the program or toggling the Note's cluster-keywords only option. This may be a bug. See Issue 402.

Bookmarks tab

Bookmarks tab

Attachments tab

Attachments tab

Bottom buttons

Bottom buttons