Skip to content

User Manual

Jump to bottom
Pavlo Myroniuk edited this page Oct 19, 2024 · 1 revision

Configuring

Remember: you need to restart the app to apply changes.

The only way to configure the application is by editing the config.toml file. It is in ${APP_DATA_DIR}/com.tbt.dataans/configs directory. The ${APP_DATA_DIR} value is platform-specific:

  • Linux: Resolves to $XDG_DATA_HOME or $HOME/.local/share.
  • macOS: Resolves to $HOME/Library/Application Support.
  • Windows: Resolves to {FOLDERID_RoamingAppData}.

Color theme

The color theme is also configurable. All values are defined in a separate .toml file. The Dataans has a default one, but you can change it or create your theme file and set its name in the config.toml. But remember, that the theme file should be placed in ${APP_DATA_DIR}/com.tbt.dataans/configs.

The theme file looks like this:

# dark_theme.toml
notes-background-color = "#232634"
notes-border-color = "#24192a"
spaces-background-color = "#232634"
spaces-tools-background-color = "#232634"
spaces-tools-border-color = "#c6c4af"
spaces-tools-text-color = "#c6c4af"
messages-info-background-color = "#232634"
messages-info-text-color = "#ababad"
# ...

This config file is just converted to CSS code and injected into the DOM (here: injecting and to CSS conversion). So, you can set any CSS-valid values you want.

Main UI components

Let's take this screenshot:

image

The app consists of 6 main UI "blocks":

  1. Space info panel.
  2. Toolbar.
  3. Sidebar.
  4. App info.
  5. Note input.
  6. Note list.

Spaces info panel

image

This panel contains space name and buttons for space editing, deletion, and searching notes in this space.

Toolbal

It has two states:

  1. Minimized: image
  2. Expanded:
    image

The user can create a new space or enter the search queue using this panel.

Sidebar

The sidebar is used for listing user's spaces or found notes. As the toolbar, the sidebar also has two states: minimized and expanded.

image image

App info

The app info can be used for retrieving the basic app info and current keybindings settings. To open it just click on the version label:

image

It will open the next window:

image

All data is copiable but not editable. The only way to change settings is to edit the config file.

Note input

It is just a text area on steroids 💊. It is used for note creation and file attachment.

image

It allows the user to enter the text, attach or remove files, and submit the note.

Note list

This section contains all the notes in the current space. All notes are sorted by timestamp.

image

Every note contains a creation timestamp, note text, and buttons for note editing/deletion (visible on hover):

image

Keybindings

App navigation

Dataans supports rich keybindings support for app navigation and all of them are configurable (see Configuring).

Action Default key combination
toggle-spaces-bar (toggle side bar) ControlLeft+keyS
create-space ControlLeft+keyN
edit-current-space ControlLeft+keyE
delete-current-space ControlLeft+Delete
select-prev-list-item AltLeft+Digit1
select-next-list-item AltLeft+Digit2
find-note ControlLeft+keyF

select-prev/next-list-item means to navigate up/down in the spaces/found notes list.

Any pop-up window can be closed with the esc key or submitted with the enter key.

Text editing

You can use keybindings to format your text when typing a note. Text editing keybindings are not configurable.

Action Key combination
Create link ctrl+k
Strong (bold) text ctrl+b
Cursive (italic) text ctrl+i
In-line code ctrl+shift+m
Clone this wiki locally