Tp-Note - fast note-taking with templates and filename synchronization


Table of Contents

1. Documentation
2. Source code
3. Distribution
3.1. Tp-Note Microsoft Windows installer package
3.2. Tp-Note Debian/Ubuntu installer package
3.3. Various binaries for Windows, MacOS and Linux
4. Installation
5. Upgrading
6. Building
7. About

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. By default, TP-Note launches the system file-editor (or any other of your choice, e.g. MarkText or Typora) after creating a new note.

1. Documentation

User documentation:

Developer documentation:

  • API documentation

    Tp-Note’s program code documentation targets mainly software developers. The advanced user may consult the Tp-Note’s config module documentation which explains the default templates and setting. Many of them can be customized through Tp-Note’s configuration file.

    API documentation

2. Source code

Repository:

3. Distribution

3.1. Tp-Note Microsoft Windows installer package

  • Installer package for Windows:

    tp-note-1.8.0-x86_64.msi

    As this early version of the Windows installer is not signed yet, Windows will show the error message Windows protected your PC. As a work-around, when you click on the link More info, a ”Run anyway” button will appear allowing you to continue the installation process. In general, regardless of where a program comes from, I recommend checking every installable file with VirusTotal.

3.2. Tp-Note Debian/Ubuntu installer package

3.3. Various binaries for Windows, MacOS and Linux

4. 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-1.8.0-x86_64.msi is available. For more information, please consult the Distribution section above and the Installation section in Tp-Note’s manual.

5. 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 erroneous 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.
---
Additional technical details:
*    Command line parameters:
tp-note
*    Configuration file path:
/home/getreu/.config/tp-note/tp-note.tomll

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.
---
Additional technical details:
*    Command line parameters:
tp-note
*    Configuration file path:
/home/getreu/.config/tp-note/tp-note.toml

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.

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

    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
    

If you can 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 in stderr.

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

See also the user manual for a detailed installation description.

This project follows Semantic Versioning.

7. About

Author:

  • Jens Getreu

Copyright:

  • Apache 2 licence or MIT licence