diff options
Diffstat (limited to 'doc/asciidoc/filters/code/code-filter-readme.txt')
| -rw-r--r-- | doc/asciidoc/filters/code/code-filter-readme.txt | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/asciidoc/filters/code/code-filter-readme.txt b/doc/asciidoc/filters/code/code-filter-readme.txt new file mode 100644 index 0000000..2a35f86 --- /dev/null +++ b/doc/asciidoc/filters/code/code-filter-readme.txt @@ -0,0 +1,37 @@ +AsciiDoc Code Filter +==================== + +This simple minded filter highlights source code keywords and +comments. + +NOTE: The filter is to demonstrate how to write a filter -- it's much +to simplistic to be passed off as a code syntax highlighter. If you +want a full featured highlighter use the 'source highlighter filter. + + +Files +----- +code-filter.py:: + The filter Python script. +code-filter.conf:: + The AsciiDoc filter configuration file. +code-filter-test.txt:: + Short AsciiDoc document to test the filter. + + +Installation +------------ +The code filter is installed in the distribution `filters` directory +as part of the standard AsciiDoc install. + +Test it on the `code-filter-test.txt` file: + + $ asciidoc -v code-filter-test.txt + $ firefox code-filter-test.txt & + + +Help +---- +Execute the filter with the help option: + + $ ./code-filter.py --help |