Author: wyoung
Date: Mon Mar 19 21:17:12 2007
New Revision: 1460
URL: http://svn.gna.org/viewcvs/mysqlpp?rev=1460&view=rev
Log:
Reorganized documentation so HTML outputs go in subdirs of doc/html,
instead of the html subdirs being scattered under various other subdirs.
This makes the links between the two halves of the documentation
simpler, and it's easier to grab just the generated parts of the docs
when you don't want the sources.
Added:
trunk/doc/html/
- copied from r1456, trunk/doc/userman/html/
trunk/doc/html/refman/
- copied from r1457, trunk/doc/refman/html/
trunk/doc/html/userman/
trunk/doc/html/userman/tangentsoft.css
Removed:
trunk/doc/html/userman.css
trunk/doc/refman/html/
trunk/doc/userman/html/
Modified:
trunk/doc/userman/Makefile
trunk/doc/userman/html.xsl
trunk/lib/Doxyfile.in
trunk/mysql++.bkl
trunk/mysql++.spec.in
Added: trunk/doc/html/userman/tangentsoft.css
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/doc/html/userman/tangentsoft.css?rev=1460&view=auto
==============================================================================
--- trunk/doc/html/userman/tangentsoft.css (added)
+++ trunk/doc/html/userman/tangentsoft.css Mon Mar 19 21:17:12 2007
@@ -1,0 +1,84 @@
+BODY {
+ background-color: #FFFFEE;
+}
+
+a:link {
+ color: #491E00;
+}
+
+a:visited {
+ color: #7D2E01;
+}
+
+a:hover {
+ color: #CC5500;
+ text-decoration: none;
+}
+
+a:active {
+ color: #DA7417;
+}
+
+H1 {
+ font-family: verdana, helvetica narrow, arial, univers, sans-serif;
+ font-size: 20pt;
+ color: #501000;
+}
+
+H2 {
+ font-family: verdana, helvetica narrow, arial, univers, sans-serif;
+ font-size: 16pt;
+ font-weight: bold;
+ color: #501000;
+}
+
+H3 {
+ font-family: verdana, helvetica narrow, arial, univers, sans-serif;
+ font-size: 14pt;
+ font-weight: bold;
+ color: #501000;
+}
+
+H4 {
+ font-family: verdana, helvetica narrow, arial, univers, sans-serif;
+ font-size: 10pt;
+ font-weight: bold;
+ color: #501000;
+}
+H4.subtitle {
+ margin-left: 20pt;
+}
+
+H5 {
+ font-family: verdana, helvetica narrow, arial, univers, sans-serif;
+ font-size: 10pt;
+ font-weight: bold;
+ color: #501000;
+ margin-left: 20pt;
+}
+
+P {
+ line-height: 140%;
+ margin-left: 20pt;
+}
+
+div.sect3 {
+ margin-left: 20pt;
+}
+
+li {
+ margin-left: 30pt;
+}
+
+li p {
+ margin-left: 0pt;
+}
+
+pre.programlisting {
+ border: 1px solid #882200;
+ margin: 10pt;
+ margin-left: 40pt;
+ padding: 10pt;
+ background-color: #FFFFCC;
+}
+
Modified: trunk/doc/userman/Makefile
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/doc/userman/Makefile?rev=1460&r1=1459&r2=1460&view=diff
==============================================================================
--- trunk/doc/userman/Makefile (original)
+++ trunk/doc/userman/Makefile Mon Mar 19 21:17:12 2007
@@ -9,6 +9,7 @@
## Input files
## ------------------------
+HTML_DIR=../html/userman
BASENAME=userman
DOCFILE=$(BASENAME).dbx
PDFFILE=$(BASENAME).pdf
@@ -26,7 +27,7 @@
## Major output rules
## ------------------------
-html: html/index.html
+html: $(HTML_DIR)/index.html
pdf: $(PDFFILE)
@@ -43,7 +44,7 @@
all: html pdf
clean:
- rm -f tags *.fo html/*.html *.log *.out *.pdf *.txt
+ rm -f tags *.fo $(HTML_DIR)/*.html *.log *.out *.pdf *.txt
## ------------------------
@@ -53,12 +54,11 @@
$(PDFFILE): $(DOCFILE) $(FO_SS) $(COMMON_SS)
xsltproc --xinclude $(FO_SS) $(DOCFILE) > $(FOFILE)
$(FOPDIR)/fop -q -fo $(FOFILE) $(PDFFILE)
- cp $(PDFFILE) ../mysqlpp-$(PDFFILE)
+ cp $(PDFFILE) ..
-html/index.html: $(DOCFILE) $(EX_TXT) $(HTML_SS) $(COMMON_SS)
- @mkdir -p html
+$(HTML_DIR)/index.html: $(DOCFILE) $(EX_TXT) $(HTML_SS) $(COMMON_SS)
@xmllint --xinclude --postvalid --noent --noout $(DOCFILE)
- xsltproc --xinclude -o html/ $(HTML_SS) $(DOCFILE)
+ xsltproc --xinclude -o $(HTML_DIR)/ $(HTML_SS) $(DOCFILE)
## ------------------------
Modified: trunk/doc/userman/html.xsl
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/doc/userman/html.xsl?rev=1460&r1=1459&r2=1460&view=diff
==============================================================================
--- trunk/doc/userman/html.xsl (original)
+++ trunk/doc/userman/html.xsl Mon Mar 19 21:17:12 2007
@@ -17,7 +17,7 @@
<!-- HTML-specific XSL parameters -->
<xsl:param name="chunk.fast" select="0"/>
- <xsl:param name="html.stylesheet" select="'userman.css'"/>
+ <xsl:param name="html.stylesheet" select="'tangentsoft.css'"/>
<xsl:param name="use.id.as.filename" select="1"/>
<!-- Special ulink types, to reduce boilerplate link code -->
@@ -49,7 +49,7 @@
<tt>
<a>
<xsl:attribute name="href">
-
<xsl:text>../../refman/html/classmysqlpp_1_1</xsl:text>
+
<xsl:text>../refman/classmysqlpp_1_1</xsl:text>
<xsl:value-of
select="@url"/>
<xsl:text>.html</xsl:text>
</xsl:attribute>
@@ -71,7 +71,7 @@
<tt>
<a>
<xsl:attribute name="href">
-
<xsl:text>../../refman/html/structmysqlpp_1_1</xsl:text>
+
<xsl:text>../refman/structmysqlpp_1_1</xsl:text>
<xsl:value-of
select="@url"/>
<xsl:text>.html</xsl:text>
</xsl:attribute>
Modified: trunk/lib/Doxyfile.in
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/lib/Doxyfile.in?rev=1460&r1=1459&r2=1460&view=diff
==============================================================================
--- trunk/lib/Doxyfile.in (original)
+++ trunk/lib/Doxyfile.in Mon Mar 19 21:17:12 2007
@@ -30,7 +30,7 @@
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
-OUTPUT_DIRECTORY = ../doc/refman
+OUTPUT_DIRECTORY = ../doc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@@ -644,7 +644,7 @@
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `html' will be used as the default path.
-HTML_OUTPUT = html
+HTML_OUTPUT = html/refman
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
@@ -656,7 +656,7 @@
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
-HTML_HEADER = ../doc/refman/html/_header.html
+HTML_HEADER = ../doc/html/refman/_header.html
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
Modified: trunk/mysql++.bkl
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/mysql%2B%2B.bkl?rev=1460&r1=1459&r2=1460&view=diff
==============================================================================
--- trunk/mysql++.bkl (original)
+++ trunk/mysql++.bkl Mon Mar 19 21:17:12 2007
@@ -5,6 +5,7 @@
<include file="presets/simple.bkl"/>
<set var="DBLDOLLAR">$(DOLLAR)$(DOLLAR)</set>
+ <set var="AND">&&</set>
<set var="ZLIB">yes</set>
<set var="THREAD_TYPE">single</set>
@@ -252,7 +253,10 @@
<set var="PKGNAME">[EMAIL PROTECTED]@</set>
<modify-target target="clean">
- <command>rm -f libmysqlpp.so.2</command>
+ <command>
+ cd doc/html/refman $(AND) \
+ rm -f doxygen.css
[a-z]*.{dot,html,map,md5,png}
+ </command>
</modify-target>
<action id="lib/custom.h">
@@ -273,11 +277,10 @@
<action id="ctags"><depends>tags</depends></action>
<action id="refman">
- <command>cd lib ; doxygen</command>
- <command>
- cd doc/refman/latex && \
- make pdf && \
- mv refman.pdf ../../mysqlpp-refman.pdf
+ <command>mkdir -p doc/latex</command>
+ <command>
+ cd lib ; doxygen $(AND) cd ../doc/latex $(AND) \
+ make pdf $(AND) cp refman.pdf ..
</command>
</action>
@@ -299,7 +302,7 @@
<action id="dist-build">
<!-- Set up package directory -->
<command>
- for d in config doc/refman/html
doc/userman/html examples lib ; \
+ for d in config doc/{.,html}/{refman,userman}
examples lib ; \
do \
mkdir -p $(PKGNAME)/$(DBLDOLLAR)d ; \
done
@@ -332,11 +335,11 @@
<command>
for d in refman userman ; do \
for f in *.{css,html} ; do \
- cp
doc/$(DBLDOLLAR)d/html/$(DBLDOLLAR)f \
-
$(PKGNAME)/doc/$(DBLDOLLAR)d/html ; \
+ cp
doc/html/$(DBLDOLLAR)d/$(DBLDOLLAR)f \
+
$(PKGNAME)/doc/html/$(DBLDOLLAR)d ; \
done ; \
done ; \
- cp doc/refman/html/*.png
$(PKGNAME)/doc/refman/html
+ cp doc/html/refman/*.png
$(PKGNAME)/doc/html/refman
</command>
<!-- examples subdir -->
Modified: trunk/mysql++.spec.in
URL:
http://svn.gna.org/viewcvs/mysqlpp/trunk/mysql%2B%2B.spec.in?rev=1460&r1=1459&r2=1460&view=diff
==============================================================================
--- trunk/mysql++.spec.in (original)
+++ trunk/mysql++.spec.in Mon Mar 19 21:17:12 2007
@@ -79,9 +79,12 @@
%files manuals
%defattr(-,root,root,-)
-%doc doc/*.pdf doc/README.manuals doc/refman doc/userman
+%doc doc/*.pdf doc/html doc/README.manuals
%changelog
+* Mon Mar 19 2007 Warren Young <[EMAIL PROTECTED]> 2.2.1-4
+- Reorganized locations of generated documentation
+
* Mon Mar 19 2007 Warren Young <[EMAIL PROTECTED]> 2.2.1-3
- Merge of Remi Collet's spec file with official one
_______________________________________________
Mysqlpp-commits mailing list
[email protected]
https://mail.gna.org/listinfo/mysqlpp-commits
