/extras/txt2tagsrc

 1%
 2% txt2tags sample config file
 3%
 4% This is a sample for the .txt2tagsrc user config file.
 5% Part of the txt2tags project (http://txt2tags.org).
 6%
 7% Copy this file to $HOME/.txt2tagsrc (or %homepath%/_t2trc
 8% on Windows) and edit it to fit your needs. All configs are
 9% COMMENTED, just remove the leading % for the ones you want
10% to use.
11%
12% The config syntax is:
13%
14%            %!keyword  (target)  :  value
15%
16% Keywords:
17%    target, options, encoding, style, preproc, postproc,
18%    guicolors
19% Targets:
20%    The valid txt2tags targets (i.e.: html, man, tex)
21%
22% Details:
23% - If the '(target)' part is omitted, the config is valid for
24%   all targets
25% - The %!keyword must be at the line start, no leading spaces
26% - All the options defined here can be overwritten by command
27%   line options and document config
28%
29%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
30
31
32% Set a default target if none specified
33%   Useful if you always use the same target for all documents
34%%!target: html
35
36% Set the default encoding for all documents
37%   Examples: iso-8859-1, UTF-8
38%   This can be turned off later with --no-encoding
39%%!encoding: UTF-8
40
41% Set the TOC depth for all targets
42%   Valid values: 1, 2, 3, 4, 5
43%   The default is 3
44%%!options: --toc-level 2
45
46% Always use CSS-friendly tags in HTML and XHTML
47%   This uses H1, H2 and H3 for document top title and
48%   defines the following DIV areas: header, toc, body
49%   This can be turned off later with --no-css-sugar
50%%!options( html): --css-sugar
51%%!options(xhtml): --css-sugar
52
53% Always mask e-mails from robots in HTML and MOIN documents
54%   Example: john@company.com turns to <john (a) company com>
55%   This can be turned off later with --no-mask-email
56%%!options(html): --mask-email
57%%!options(moin): --mask-email
58
59% Always enumerate all title lines for text output
60%   This can be turned off later with --no-enum-title
61%%!options(txt): --enum-title
62
63% Always make TOC (Table of Contents) in LaTeX documents
64%   This can be turned off later with --no-toc
65%%!options(tex): --toc
66
67% Change the graphical interface colors
68%   Valid values for colors: colorname, #RGB, #RRGGBB
69%   The order is: bg1, fg1, bg2, fg2
70%%!guicolors: blue white brown yellow
71
72%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
73
74%%% FILTERS
75%
76% PreProc and PostProc filters are powerful tools to customize
77% txt2tags behavior and perform nice tricks. But be careful,
78% they do use Regular Expressions and can be dangerous if bad
79% written. Really test them before including here.
80
81% Shorthand for the javascript BACK call in HTML
82%   Contribution from Prof. Sergio de Albuquerque Souza
83%   Example: [Click here JAVABACK] to go back.
84%%!postproc(html):   JAVABACK   javascript:history.back()
85
86% Trick to create super/subscript text in HTML
87%   Example: I will use ^^superscript^^ and also ,,subscript,,
88%%!postproc(html): '\^\^(.*?)\^\^'  '<span style="vertical-align:super">\1</span>'
89%%!postproc(html): ',,(.*?),,'  '<span style="vertical-align:sub">\1</span>'
90
91% LaTeX and TeX names appearing on their classical formats
92%%!postproc(tex):   LaTeX   \\LaTeX{}
93%%!postproc(tex):   \bTeX   \\TeX{}
94