TIVI-153: add as dependency for iputils
[profile/ivi/docbook-utils.git] / TODO
1                 PACKAGING
2
3 - Directories should be owned
4
5 - Use macros to ease porting
6
7 - install-catalog has problems with updates because the post-install
8   is called before the post-uninstall
9
10
11                 PRINTING
12
13 - Support hyperlinks in acroread
14
15 Hyperlinks are rendered nicely when converted to PDF, but aren't
16 dynamical in acroread (they are just underlined text)
17
18 - Support Asian languages on printing
19
20 Already did some tries with hlatex (Korean)
21
22 - Italian does not seem to work when printing
23
24 Solved with the new packaging of jadetex?
25
26 - Tables aren't rendered nicely when printing
27
28 The second line of text and the following ones have no margin
29
30 - Add a switch to control TeX verbosity
31
32
33                 BACKENDS
34
35 - Do a new text backend based on html2text instead of lynx
36
37 Merge Jochem's stuff with the current text backend. The choice of
38 the method should be passed through the command line or through an
39 configuration file.
40
41 - Do a FOT backend, MIF backend and a palm backend
42
43 Should be easy. Use -V and -t variables.
44
45 - Backend options
46
47 Provide an -e option in jw to pass directly a string to the backend
48 through the SGML_EXTRA_OPTS variable. The html backend then can pass
49 it to Jade through the -V option.
50
51 - Configuration file for backends
52
53 Pass a variable holding the name of the initialization file to the
54 backend.
55
56 (is this really needed?)
57
58
59                 JW
60
61 - Configuration variables for jw
62
63 Simpler and more powerful to use "aliases" ?
64
65 Name:           SGML_BACKEND_DIR
66     Content:    Directory containing the backends.
67     Default:    $SGML_BASE_DIR/backends/
68     Example:    /usr/share/sgml/docbook/docbook-utils-0.2/backends/
69     Notes:      This directory should contain nothing else than backends. 
70                 This way a program can tell the user about available
71                 backends by just doing "ls $SGML_BACKEND_DIR" or similar.
72
73 Name:           SGML_BACKEND
74     Content:    The name of the default backend
75     Default:    html
76 (txt would be more neutral, but then be painful to the docbook users)
77     Example:    ps
78
79 Name:           SGML_FRONTEND_DIR
80     Content:    Directory containing the frontends.
81     Default:    $SGML_BASE_DIR/frontends/
82     Example:    /usr/share/sgml/docbook/docbook-utils-0.2/frontends/
83     Notes:      This directory should contain nothing else than frontends. 
84                 This way a program can tell the user about available
85                 frontends by just doing "ls $SGML_FRONTEND_DIR" or similar.
86
87 Name:           SGML_FRONTEND
88     Content:    The name of the default frontend
89     Default:    docbook
90 (sgml would be more neutral, but then be painful to the docbook users)
91     Example:    tei
92     Notes:      At the time of determining the frontend, the frontend is not
93                 known, so it is /etc/sgml/sgml.conf or $HOME/.sgml.conf
94                 that is used as a configuration file.
95
96 Name:           SGML_HELPERS_DIR
97     Content:    The name of the directory where reside the scripts that
98                 can be called by the backends and the frontends
99     Default:    $SGML_BASE_DIR/helpers/
100     Example:    /usr/share/sgml/docbook/docbook-utils-0.2/helpers/
101
102 Name:           SGML_OUTPUT_DIR
103     Content:    The directory to write the converted output files to.
104     Default:    .
105     Example:    /tmp
106     Note:       This is not backend-specific. If for example the html
107                 backend wants to put the resulting files in an directory named
108                 HTML, it can override or refine this setting.
109
110 Name:           SGML_FILE
111     Content:    The filename of the SGML source-file to convert.
112     Default:    index.sgml
113     Example:    index.docbook
114
115 Name:           SGML_JADE
116     Content:    The flavour of jade parser to execute
117     Default:    jade
118     Example:    openjade
119     Notes:      This variable is unused if using another parser
120
121 Name:           SGML_STYLESHEET
122     Content:    The stylesheet to use
123     Default:    (unset)
124     Example:    /usr/share/sgml/docbook/kde-0.1/stylesheet/kde.dsl#html
125
126 An "alias" on the contrary would concentrate all the options passed on the command
127 line into a single symbol. Example:
128       htmlkde <=> -c /usr/share/sgml/docbook/kde-0.1/catalog
129                   -d /usr/share/sgml/docbook/kde-0.1/kde.dsl#html