title: Tp-Note - Minimalist note taking: save and edit your clipboard content as a note file

Cargo Documentation License

Tp-Note is a note-taking-tool and a template system - freely available for Windows, MacOS and Linux - that consistently synchronizes the note’s meta-data with its filename. If you like to keep your notes next to your files and you care about expressive filenames, then Tp-Note might be the tool of your choice. Tp-Note collects various information about its environment and the clipboard and stores them in variables. New notes are created by filling these variables in predefined and customizable Tera-templates. TP-Note's default templates are written in Markdown and can be easily adapted to any other markup language if needed. After creating a new note, TP-Note launches the system file editor (or any other of your choice, e.g. MarkText or Typora) and connects the default web browser to Tp-Note's internal Markdown/RestructuredText renderer and web server.

Documentation

User documentation:

Developer documentation:

Source code

Repository:

Distribution

Tp-Note Microsoft Windows installer package

Tp-Note Debian/Ubuntu installer package

Various binaries for Windows, MacOS and Linux

Installation

Depending on the availability of installer packages for your operating system, the installation process is more or less automated. For Windows users the fully automated installation package [tp-note-latest-x8664.msi] is available. For more information, please consult the Distribution section above and the [Installation section] in _Tp-Note's manual.

Upgrading

While upgrading Tp-Note, new features may cause a change in Tp-Notes's configuration file structure. In order not to loose the changes you made in this file, the installer does not replace it automatically with a new version. Instead, Tp-Note renames the old configuration file and prompts:

NOTE: configuration file version mismatch:
---
Configuration file version: '1.7.2'
Tp-Note version: '1.7.4'
Minimum required configuration file version: '1.7.4'

For now, Tp-Note backs up the existing configuration
file and next time it starts, it will create a new one
with default values.

or

NOTE: unable to load, parse or write the configuration file
---
Reason:
        Bad TOML data: missing field `extension_default` at line 1 column 1!

Note: this error may occur after upgrading Tp-Note due
to some incompatible configuration file changes.

For now, Tp-Note backs up the existing configuration
file and next time it starts, it will create a new one
with default values.

As the above error messages suggests, all you need to do is to restart Tp-Note in order to create a new updated configuration file.

Building

If the above precompiled binaries do not suite you, you can compile Tp-Note yourself.

  1. [Install Rust], e.g.

    curl https://sh.rustup.rs -sSf | sh

  2. Download, compile and install Tp-Note:

    Building for Linux

    sudo apt-get install -y xorg-dev libxcb-xfixes0-dev libxcb-shape0-dev libgtk-3-dev cargo install tp-note sudo cp ~/.cargo/bin/tp-note /usr/local/bin

    In case you experience compilation errors in dependent crates, replace cargo install tp-note with the following:

    cargo install --locked tp-note

    If - under Linux - you need to reduce the binary size and you can do without error message popup boxes (for example on a headless system), no GTK is required. In this case all error messages are dumped on the console from where you started Tp-Note into stderr.

    cargo install --no-default-features --features read-clipboard,viewer,renderer tp-note sudo cp ~/.cargo/bin/tp-note /usr/local/bin

    Minimal Linux console version without dependencies on GUI libraries

    The full featured version of Tp-Note depends on GUI libraries like GTK that might not be installed on a headless system. Either download the Musl version [x8664-unknown-linux-musl/release/tp-note] or compile _Tp-Note without default features:

    cargo install --no-default-features tp-note sudo cp ~/.cargo/bin/tp-note /usr/local/bin

    Note, that even though this no-renderer version is deprived of it's markup renderer, limited rendered HTML export is still available (see command line option --export). This way you can comfortably follow hyperlinks in your note files with any text based web browser, e.g. lynx.

    Recommended Linux console and server version

    The same as the above console version (without GUI libraries), but with additional Markdown, ReStructuredText etc. renderer compiled in.

    cargo install --no-default-features --features renderer tp-note sudo cp ~/.cargo/bin/tp-note /usr/local/bin

    Building for Windows

    Build the full featured version with:

    cargo install tp-note

    When building for Windows, it does not make sense to exclude the message-box feature, because - under Windows - it does not rely on the GTK library. Instead it uses direct Windows-API calls for popping up alert boxes. As these calls have no footprint in binary size or speed, always keep the message-box feature compiled in.

    See also the user manual for a more detailed installation description.

This project follows [Semantic Versioning].

About

Author:

Copyright: