templates/README.md
author Mikael Berthe <mikael@lilotux.net>
Sun, 07 May 2017 11:56:37 +0200
changeset 82 9ac2281c07d7
parent 23 2ba1ea451669
child 86 9e846c5af138
permissions -rw-r--r--
Add 'template_directory' setting If set, template files are looked up relatively from this repository first (unless they are absolute paths or start with "./" or "../").
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
23
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     1
# Templates
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     2
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     3
This folder contains sample templates to customize madonctl output.
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     4
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     5
I'd like to eventually have support for themes with collections of templates.
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     6
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     7
Here's an example using a template with ANSI color escape codes (for UNIX/Linux):
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     8
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
    madonctl timeline --limit 2 --template-file ansi-status.tmpl
2ba1ea451669 Add template samples
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    10
82
9ac2281c07d7 Add 'template_directory' setting
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    11
The template prefix directory can be set in the configuration file with the 'template_directory' setting,
9ac2281c07d7 Add 'template_directory' setting
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    12
or with the `MADONCTL_TEMPLATE_DIRECTORY` environment variable. \
9ac2281c07d7 Add 'template_directory' setting
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    13
If set, template files are looked up relatively from this repository first
9ac2281c07d7 Add 'template_directory' setting
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    14
(unless they are absolute paths or start with "./" or "../").
9ac2281c07d7 Add 'template_directory' setting
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    15
9ac2281c07d7 Add 'template_directory' setting
Mikael Berthe <mikael@lilotux.net>
parents: 23
diff changeset
    16
Feel free to contribute if you have nice templates or if you want to work on themes as well!