ToText is a collection of bash scripts for using an annotation system with md files. It builds upon the zim desktop wiki. The md files are describing every given file on your file system. The created md file is showing up in zim. So you can search and annotate a file in zim wiki. Some scripts connect zim with the file manager dolphin and the web browser firefox. The scripts are working on Linux machines like Ubuntu, Archlinux, Fedora, Suse.
The scipts begin with the shortcut tt for ToText.
For updates see CHANGELOG-JOURNAL.md.
The ToText uses the following tools:
- wget
- xidel
- scrot
- sed
- yad
- firefox addon external application
- firefox addon zim clip
- noweb - noweb.py repository
- mypaint
- krita
- xournalpp
- yt-dlp
- mpv player
- zim - desktop wiki
You can install the script by the install.sh script by simply execute the script or go to the Execute installation steps section and run the commands by your self, additionally it explains the install.sh scripts steps.
chmod u+x install.sh && ./install.shDownload the repository with
Download repository
git clone https://github.com/christiang7/ToText.git
cd ToTextCreate a folder under the .config folder in your home /home/username/
create tt config folder
mkdir -p ~/.config/ttCopy the config-example file to your .config folder
copy tt config
cp configs/config-example ~/.config/tt/configand fill in your path you need.
Copy the config-mpv-example to your mpv config folder
copy mpv config
cp configs/config-mpv-example ~/.config/mpv/configCopy all .desktop files to the dolphin service folder
copy .desktop files
cp -r desktop-files/*.desktop ~/.local/share/kservices5/ServiceMenus/*.desktopCopy all scripts to the local bin folder
copy script files
list=$(ls -1 --hide=*.md "Scripts")
cp $list .local/bin/*Install all listed programs from the section Description above.
Finished.
The script file of the used installation steps.
install.sh
#!/bin/bash
#*create tt config folder}}
#*copy tt config}}
#*copy mpv config}}
#*copy .desktop files}}
#*copy script files}}You can find the used code and documentation in the previous section Execute installation steps
make.sh
noweb.py -Rinstall.sh README.md > install.sh && echo 'install.sh' && date