diff options
author | Jonathon Jongsma <jjongsma@src.gnome.org> | 2008-02-16 03:36:05 +0000 |
---|---|---|
committer | Jonathon Jongsma <jjongsma@src.gnome.org> | 2008-02-16 03:36:05 +0000 |
commit | 00ede421b02893f68f854bfbe647378e76813f2c (patch) | |
tree | 3fe0a5698d1cdd597ac89b5f829943ce00b862af /docs | |
parent | ff9cfc6fd26b6754b8b7bd07ebdba7f4e26d9720 (diff) | |
download | glibmm-00ede421b02893f68f854bfbe647378e76813f2c.tar.gz |
make this more general instead of hard-coding the name and title and
* docs/reference/doxygen_to_devhelp.xsl: make this more general instead of
hard-coding the name and title and reference path into the stylesheet --
instead pass them as parameters on the commandline
* docs/reference/Makefile.am: use new GMMPROC_DIR variable. Also install
the doxygen_to_devhelp.xsl stylesheet so that other libraries can use the
installed version instead of having everybody copy the file into their own
library if they want to generate a devhelp book
svn path=/trunk/; revision=602
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/Makefile.am | 18 | ||||
-rw-r--r-- | docs/reference/doxygen_to_devhelp.xsl | 10 |
2 files changed, 19 insertions, 9 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index 68906c1a..18114c42 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -6,12 +6,18 @@ beautify_docs = $(srcdir)/beautify_docs.pl devhelp_file = glibmm-2.4.devhelp devhelp_stylesheet = doxygen_to_devhelp.xsl +referencedir = $(gtkmm_docdir)/reference/html +devhelpdir = $(datadir)/devhelp/books/glibmm-2.4 + +stylesheetdir = $(gtkmm_docdir) +stylesheet_DATA = $(devhelp_stylesheet) + include $(top_srcdir)/docs/Makefile_web.am_fragment web_path_reference = $(web_path_docs)reference EXTRA_DIST = README Doxyfile.in \ glibmm_header.html_fragment glibmm_footer.html_fragment beautify_docs.pl \ - html glibmm_doxygen_tags libstdc++.tag.xml doxygen_to_devhelp.xsl $(devhelp_file) + html glibmm_doxygen_tags libstdc++.tag.xml $(devhelp_stylesheet) $(devhelp_file) #Ideally, libstdc++.tag.xml would be installed by gcc, instead of being copied into every project. # the xml output is made along with the html output @@ -19,7 +25,10 @@ xml/index.xml: html/index.html # Build a DevHelp reference from the doxygen xml $(devhelp_file): xml/index.xml $(devhelp_stylesheet) - xsltproc -o $@ $(devhelp_stylesheet) xml/index.xml + xsltproc --stringparam book_title "glibmm 2.4 Reference Manual" \ + --stringparam book_name "glibmm 2.4" \ + --stringparam reference_prefix "$(referencedir)" \ + -o $@ $(devhelp_stylesheet) xml/index.xml html/index.html: $(doxygen_configfile_source) $(beautify_docs_source) $(top_srcdir)/glib/glibmm/*.h -rm -rf html @@ -48,9 +57,6 @@ doc-clean: -rm -f glibmm_doxygen_tags -rm -f glibmm-reference-html.tar.gz glibmm-reference-html.tar.bz2 -referencedir = $(gtkmm_docdir)/reference/html -devhelpdir = $(datadir)/devhelp/books/glibmm-2.4 - install-reference: html/index.html $(devhelp_file) @$(NORMAL_INSTALL) $(mkinstalldirs) $(DESTDIR)$(referencedir) @@ -73,7 +79,7 @@ uninstall-reference: html/index.html # Install beautify_docs.pl, next to gmmproc. gmmproc_bin_SCRIPTS = $(beautify_docs) -gmmproc_bindir = $(libdir)/glibmm-2.4/proc +gmmproc_bindir = $(GMMPROC_DIR) all-local: html/index.html diff --git a/docs/reference/doxygen_to_devhelp.xsl b/docs/reference/doxygen_to_devhelp.xsl index cb84da14..d4e1371a 100644 --- a/docs/reference/doxygen_to_devhelp.xsl +++ b/docs/reference/doxygen_to_devhelp.xsl @@ -5,11 +5,15 @@ <xsl:output method="xml" version="1.0" indent="yes"/> -<xsl:param name="reference_prefix">../../../doc/glibmm-2.4/docs/reference/html/</xsl:param> +<!-- these are parameters so that this stylesheet can be used by multiple +libraries. Pass them in on the commandline --> +<xsl:param name="book_title"/> +<xsl:param name="book_name"/> +<xsl:param name="reference_prefix"/> <xsl:template match="/"> - <book title="glibmm 2.4 library Reference Manual" - name="glibmm 2.4" + <book title="{$book_title}" + name="{$book_name}" link="{$reference_prefix}/index.html"> <chapters> <sub name="Classes" link="{$reference_prefix}classes.html"> |