TODO

   1
   2 The TODO list for the gtk-doc project is at Bugzilla,
   3 the bugtracking system of the GNOME project.
   4
   5 Visit
   6  http://bugzilla.gnome.org/buglist.cgi?product=gtk-doc&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED
   7 to see what is allready requested, or where you can help. :-)
   8
   9 To put an other request on the TODO list, visit
  10  http://bugzilla.gnome.org/enter_bug.cgi?product=gtk-doc
  11
  12 Also have a look at
  13  http://live.gnome.org/DocumentationProject/GtkDocFuture
  14 and join discussion about future features.
  15
  16
  17 Developers can also add items here :)
  18
  19 = Tracing =
  20 * there is a bunch of #print statements for tracing
  21   => add a sub Trace() to gtkdoc-common.pl
  22   => use @TRACE@ "..." and depending on configure flag
  23      turn that into
  24        [print __FILE__ . ":" . __LINE__ . ":" . ] or [#]
  25      should be a function and the function should support loglevels and an
  26        envar to enable/disable conditionally;
  27
  28 = More abbreviations =
  29 * expand urls
  30
  31 = Testing =
  32 cd test/gobject
  33 diff -u --exclude="Makefile*" docs docs-tmpl | diffstat
  34
  35 = Issues =
  36 * gtkdoc-fixxref makefile targets use $HTML_DIR
  37   * HTML_DIR: The directory where gtk-doc generated documentation is installed
  38     it comes from gtk-doc.m4 (--with-html-dir) but has no default
  39   * automake exports $htmldir which is by default:
  40     ${prefix}/share/doc/${PACKAGE_TARNAME}
  41   * the Makefile uses $(DESTDIR)$(TARGET_DIR)
  42     where TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE)
  43     http://www.gnu.org/software/libtool/manual/automake/DESTDIR.html
  44
  45 = Output =
  46 * http://sagehill.net/docbookxsl/index.html
  47 * multipage-html
  48   * would be good to be able to have page titles as a concatenation of document
  49     name and page name (gtk+:GtkWIdget)
  50 * formats
  51   http://bugzilla.gnome.org/show_bug.cgi?id=531572
  52   http://bugzilla.gnome.org/show_bug.cgi?id=466535
  53   we need more configure options in gtk-doc.m4:
  54   --(enable|disable)-gtk-doc-(html|pdf|man|html-single|rtf)
  55   - html : enabled by default
  56   - html-single : is single page html
  57 * validation
  58     xmllint --noout --xinclude --postvalid tester-docs.xml
  59     xmllint --noout --postvalid tester-docs.fo --dtdvalid file://$HOME/download/fo.dtd
  60     - fo.dtd : http://www.renderx.com/Tests/validator/fo.zip
  61 * single page
  62   xsltproc  --nonet --xinclude -o gtk-docs.html /home/ensonic/projects/gtk-doc/gtk-doc-single.xsl  gtk-docs.sgml
  63 * pdf
  64   * xmlto via passivetex
  65     xmlto --skip-validation pdf tester-docs.xml
  66   * fop
  67     ~/download/fop-0.95beta/fop -xsl /usr/share/xml/docbook/stylesheet/nwalsh/fo/docbook.xsl -xml tester-docs.xml -pdf tester-docs.pdf
  68     ~/download/fop-0.94/fop  -xsl /usr/share/xml/docbook/stylesheet/nwalsh/fo/docbook.xsl -xml tester-docs.xml -pdf tester-docs.pdf
  69   * xsltproc + fop
  70     xsltproc  --nonet --xinclude -o tester-docs.fo ../../../gtk-doc-fo.xsl tester-docs.xml
  71     ~/download/fop-0.94/fop -fo tester-docs.fo -pdf tester-docs.pdf
  72   * xsltproc + passivetex
  73     pdflatex "&pdfxmltex" tester-docs.fo
  74     xmltex tester-docs.fo
  75
  76   * bugs/problems/howto
  77     * xmlto via passivetex
  78       http://bugs.gentoo.org/show_bug.cgi?id=224937
  79       http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=310148
  80       - info
  81         http://www.tug.org/texlive/devsrc/Master/texmf-dist/doc/xmltex/passivetex/
  82     * fop
  83       - download fop
  84         http://mirror.eunet.fi/apache/xmlgraphics/fop/binaries/
  85         http://xmlgraphics.apache.org/fop/0.94/running.html
  86         export FOP_OPTS="-Dhttp.proxyHost=eswebproxy00.europe.nokia.com -Dhttp.proxyPort=8080"
  87       - download offo
  88         http://sourceforge.net/project/showfiles.php?group_id=116740&package_id=129569&release_id=267101
  89         and copy fop-hyph.jar to fop-0.9*/lib/
  90 * rtf
  91  ~/download/fop-0.94/fop -fo tester-docs.fo -rtf tester-docs.rtf
  92  * unrtf
  93    unrtf -t ps tester-docs.rtf >tester-docs.ps
  94    unrtf -t latex tester-docs.rtf >tester-docs.tex
  95    - bad output
  96
  97 = Indexes =
  98 * http://www.w3.org/TR/2003/WD-xinclude-20031110/#syntax
  99 <xi:include href="index-symbols.html">
 100   <xi:fallback><index /></xi:fallback>
 101 </xi:include>
 102 * index terms
 103   http://sourceforge.net/tracker/index.php?func=detail&aid=1986587&group_id=21935&atid=373747
 104
 105 * we could add smart navigation for index/glossary pages
 106   (like the subsections on the doc-pages)
 107
 108 = Cleanup =
 109 * can we deprecate title in the sectionfile and request people to have this in
 110   the SECTION comment?
 111
 112 = Warnings =
 113 * add some -Wxxx parameters to help qa work
 114   - 'deprecated' deprecating 'features'
 115   - 'dummy-docs' check if symbol docs are very short and repeat mainly words
 116     from the symbol.
 117