[gtkmm-documentation] Rename GNOME doc module to gtkmm-tutorial
- From: Daniel Elstner <daniel src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtkmm-documentation] Rename GNOME doc module to gtkmm-tutorial
- Date: Fri, 11 Sep 2009 12:29:31 +0000 (UTC)
commit 02785a031484eaed2f84c979c8fc01ffcb4c69c2
Author: Daniel Elstner <danielk openismus com>
Date: Fri Sep 11 14:24:18 2009 +0200
Rename GNOME doc module to gtkmm-tutorial
* docs/tutorial/C/gtkmm-tutorial-in.xml: Rename file from
gtkmm-tut.xml, and substitute references to the filename in
the content.
* docs/tutorial/Makefile.am: Rename the intermediate file
gtkmm-tut.xml to gtkmm-tutorial-in.xml.
(DOC_MODULE): Rename the ugly gtkmm-tut-with-examples to
gtkmm-tutorial, since it will be visible as part of the URL
on library.gnome.org. Adjust references accordingly.
* docs/tutorial/README: Reference new tutorial filename.
* docs/tutorial/docbook_phpwebnotes.xsl: ditto.
.gitignore | 2 +-
ChangeLog | 15 ++++++++
.../C/{gtkmm-tut.xml => gtkmm-tutorial-in.xml} | 2 +-
docs/tutorial/Makefile.am | 38 ++++++--------------
docs/tutorial/README | 2 +-
docs/tutorial/docbook_phpwebnotes.xsl | 2 +-
6 files changed, 30 insertions(+), 31 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index d64631f..a8088f8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,6 +11,6 @@ stamp-h?
/configure.lineno
/docs/FAQ/html/
/docs/tutorial/html/
-/docs/tutorial/*/gtkmm-tut-with-examples.xml
+/docs/tutorial/*/gtkmm-tutorial.xml
/docs/tutorial/*/*.[mp]o
/gtkmm-documentation-*.tar.*
diff --git a/ChangeLog b/ChangeLog
index b51a211..9544cea 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+2009-09-11 Daniel Elstner <danielk openismus com>
+
+ Rename GNOME doc module to gtkmm-tutorial
+
+ * docs/tutorial/C/gtkmm-tutorial-in.xml: Rename file from
+ gtkmm-tut.xml, and substitute references to the filename in
+ the content.
+ * docs/tutorial/Makefile.am: Rename the intermediate file
+ gtkmm-tut.xml to gtkmm-tutorial-in.xml.
+ (DOC_MODULE): Rename the ugly gtkmm-tut-with-examples to
+ gtkmm-tutorial, since it will be visible as part of the URL
+ on library.gnome.org. Adjust references accordingly.
+ * docs/tutorial/README: Reference new tutorial filename.
+ * docs/tutorial/docbook_phpwebnotes.xsl: ditto.
+
2009-09-07 Daniel Elstner <danielk openismus com>
Update reference to the gtkmm-tut.xml file
diff --git a/docs/tutorial/C/gtkmm-tut.xml b/docs/tutorial/C/gtkmm-tutorial-in.xml
similarity index 99%
rename from docs/tutorial/C/gtkmm-tut.xml
rename to docs/tutorial/C/gtkmm-tutorial-in.xml
index 7f9c108..dfee6b7 100644
--- a/docs/tutorial/C/gtkmm-tut.xml
+++ b/docs/tutorial/C/gtkmm-tutorial-in.xml
@@ -7261,7 +7261,7 @@ consider contributing to this document.
</para>
<para>
Ideally, we would like you to <ulink url="http://www.gtkmm.org/bugs.shtml">provide a patch</ulink> to the
-<filename>docs/tutorial/C/gtkmm-tut.xml</filename> file. This file is currently
+<filename>docs/tutorial/C/gtkmm-tutorial-in.xml</filename> file. This file is currently
in the <literal>gtkmm-documentation</literal> module in GNOME git.
</para>
diff --git a/docs/tutorial/Makefile.am b/docs/tutorial/Makefile.am
index f267d82..4d337e5 100644
--- a/docs/tutorial/Makefile.am
+++ b/docs/tutorial/Makefile.am
@@ -11,14 +11,14 @@ DOCBOOK_PHPWEBNOTES_TRANSFORM = docbook_phpwebnotes.xsl
vpath_srclist = $(patsubst $(srcdir)/%,%,$(wildcard $(addprefix $(srcdir)/,$(1))))
vpath_listall = $(sort $(wildcard $(1)) $(if $(srcdir:.=),$(vpath_srclist)))
-EXTRA_DIST = README insert_example_code.pl C/gtkmm-tut.xml C/gtkmm-tut-with-examples.xml $(DOCBOOK_PHPWEBNOTES_TRANSFORM)
+EXTRA_DIST = README insert_example_code.pl C/gtkmm-tutorial-in.xml C/gtkmm-tutorial.xml $(DOCBOOK_PHPWEBNOTES_TRANSFORM)
DOCBOOK_STYLESHEET ?= http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl
XMLLINT = xmllint
XSLTPROC = xsltproc
DB2PDF = docbook2pdf
-DOC_MODULE = gtkmm-tut-with-examples
+DOC_MODULE = gtkmm-tutorial
DOC_ENTITIES =
DOC_INCLUDES =
DOC_FIGURES = \
@@ -92,6 +92,9 @@ DOC_LINGUAS = de
DISTCLEANFILES = html/*.html
MAINTAINERCLEANFILES = $(srcdir)/html/*.html
+# Set the use.id.as.filename param so that we don't use the chapter / section
+# number as the filename, otherwise the url will change every time anything is
+# re-ordered or inserted in the documentation
xslt_params = $(strip \
--param toc.section.depth 1 \
--stringparam html.stylesheet 'style.css' \
@@ -134,7 +137,7 @@ include $(top_srcdir)/build/gnome-doc-utils.make
dist-hook: doc-dist-hook
-all-local: $(addsuffix /gtkmm-tut-with-examples.xml,C $(DOC_LINGUAS)) html/index.html
+all-local: $(addsuffix /gtkmm-tutorial.xml,C $(DOC_LINGUAS)) html/index.html
install-data-local: install-tutorial
@@ -153,10 +156,7 @@ uninstall-tutorial:
# Create a html generation of the C locale's version of the DocBook,
# using our custom stylesheet and graphics:
-# Set the use.id.as.filename param so that we don't use the chapter / section
-# number as the filename, otherwise the url will change every time anything is
-# re-ordered or inserted in the documentation
-html/index.html: $(srcdir)/C/gtkmm-tut-with-examples.xml
+html/index.html: $(srcdir)/C/gtkmm-tutorial.xml
rm -fr html
$(MKDIR_P) html
$(XSLTPROC) $(xslt_params) -o html/ --xinclude --catalogs '$(DOCBOOK_STYLESHEET)' $<
@@ -166,28 +166,18 @@ html/index.html: $(srcdir)/C/gtkmm-tut-with-examples.xml
html/%: | html/index.html
# Create a DocBook source file that doesn't have the examples' comments blocks:
-$(srcdir)/C/gtkmm-tut-with-examples.xml: $(srcdir)/C/gtkmm-tut.xml $(srcdir)/insert_example_code.pl
+$(srcdir)/C/gtkmm-tutorial.xml: $(srcdir)/C/gtkmm-tutorial-in.xml $(srcdir)/insert_example_code.pl
$(PERL) -- $(srcdir)/insert_example_code.pl $(top_srcdir)/examples/book $< >$@
-validate_original: $(srcdir)/C/gtkmm-tut.xml
+validate_original: $(srcdir)/C/gtkmm-tutorial-in.xml
$(XMLLINT) --xinclude --postvalid --noout $<
-validate: $(srcdir)/C/gtkmm-tut-with-examples.xml
+validate: $(srcdir)/C/gtkmm-tutorial.xml
$(XMLLINT) --xinclude --postvalid --noout $<
-#gtkmm-tut-html.tar.gz: html/index.html
-# tar cf - C/figures html | gzip -c --best >$@
-
-#post-html: html/index.html html/style.css pdf
-# rsync $(rsync_args) C/figures/*.png $$USER $(web_host):$(gtkmm_tut_path)/figures/
-# rsync $(rsync_args) icons/*.png $$USER $(web_host):$(gtkmm_tut_path)/icons/
-# rsync $(rsync_args) -r html/ $$USER $(web_host):$(gtkmm_tut_path)/html/
-# rsync $(rsync_args) *.css $$USER $(web_host):$(gtkmm_tut_path)/html/
-# rsync $(rsync_args) -r pdf/ $$USER $(web_host):$(gtkmm_tut_path)/pdf/
-
# we need to produce a full examples with all of the XIncludes done so that it
# can processed for PDF
-C/programming-with-gtkmm-pdf.xml: $(srcdir)/C/gtkmm-tut-with-examples.xml
+C/programming-with-gtkmm-pdf.xml: $(srcdir)/C/gtkmm-tutorial.xml
$(MKDIR_P) C
$(XMLLINT) --xinclude --postvalid $< -o $@
@@ -198,12 +188,6 @@ pdf/programming-with-gtkmm-pdf.pdf: C/programming-with-gtkmm-pdf.xml
$(MKDIR_P) pdf
$(DB2PDF) --output pdf/ $<
-#pdf: pdf/programming-with-gtkmm-pdf.pdf
-
-#doc-clean:
-# -rm -f C/gtkmm-tut-with-examples.xml gtkmm-tut-html.tar.gz C/programming-with-gtkmm-pdf.xml
-# -rm -rf pdf
-
.PHONY: install-tutorial uninstall-tutorial
# Instruct GNU make to delete the targets of a rule after it failed, in
diff --git a/docs/tutorial/README b/docs/tutorial/README
index b6b2f8d..06a0ba5 100644
--- a/docs/tutorial/README
+++ b/docs/tutorial/README
@@ -1,4 +1,4 @@
-gtkmm-tut.xml is a gtkmm tutorial in DocBook XML format.
+gtkmm-tutorial-in.xml is a gtkmm tutorial in DocBook XML format.
You can build the html by typing
make html
diff --git a/docs/tutorial/docbook_phpwebnotes.xsl b/docs/tutorial/docbook_phpwebnotes.xsl
index 356b44b..074dcbb 100644
--- a/docs/tutorial/docbook_phpwebnotes.xsl
+++ b/docs/tutorial/docbook_phpwebnotes.xsl
@@ -11,7 +11,7 @@ set XML_DEBUG_CATALOG=1
<!--
xsltproc command line:
-xsltproc -o html/ -xinclude docbook_phpwebnotes.xsl gtkmm-tut-with-examples.xml
+xsltproc -o html/ -xinclude docbook_phpwebnotes.xsl gtkmm-tutorial.xml
-->
<!-- set 'html.ext' to '.php' -->
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]