selinux-faq Makefile,1.10,1.11
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/selinux-faq
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv18214/selinux-faq
Modified Files:
Makefile
Log Message:
Update all Makefiles to use the new required macro for including the Makefile.common. This will work whether you check out the entire repository at one time or a single module with an included docs-common.
Index: Makefile
===================================================================
RCS file: /cvs/docs/selinux-faq/Makefile,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- Makefile 31 Oct 2006 20:55:31 -0000 1.10
+++ Makefile 12 Mar 2007 01:10:32 -0000 1.11
@@ -37,7 +37,11 @@
endef
#
########################################################################
-include ../docs-common/Makefile.common
+define find-makefile-common
+for d in docs-common ../docs-common ../../docs-common; do
+if [ -f $$d/Makefile.common ]; then echo "$$d/Makefile.common"; break; fi; done
+endef
+include $(shell $(find-makefile-common))
########################################################################
# If you want to add additional steps to any of the
# targets defined in "Makefile.common", be sure to use
17 years, 1 month
docs-common/xsl main-pdf.xsl,1.5,1.6
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/docs-common/xsl
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv12620/xsl
Modified Files:
main-pdf.xsl
Log Message:
Use new rule to locate docs-common and rely on this for most building, instead of a possibly nonexistent FDPDIR. This should make a module inclusion or a full repository checkout equally workable.
Index: main-pdf.xsl
===================================================================
RCS file: /cvs/docs/docs-common/xsl/main-pdf.xsl,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- main-pdf.xsl 13 Mar 2006 21:46:58 -0000 1.5
+++ main-pdf.xsl 12 Mar 2007 00:08:35 -0000 1.6
@@ -15,17 +15,17 @@
<xsl:param name="section.autolabel" select="1"/>
<xsl:param name="fop.extensions" select="0"/>
-<xsl:param name="FDPDIR">..</xsl:param>
+<xsl:param name="FDPCOMMONDIR">docs-common</xsl:param>
<!-- THIS MUST BE AN ABSOLUTE PATH OR URL; PDF GETS BUILT IN A TMPDIR -->
<xsl:param name="callout.graphics.path">
<xsl:value-of
- select="concat( $FDPDIR, '/docs-common/stylesheet-images/' )"/>
+ select="concat( $FDPCOMMONDIR, '/stylesheet-images/' )"/>
</xsl:param>
<xsl:param name="admon.graphics.path">
<xsl:value-of
- select="concat( $FDPDIR, '/docs-common/stylesheet-images/' )"/>
+ select="concat( $FDPCOMMONDIR, '/stylesheet-images/' )"/>
</xsl:param>
<!-- FIXME -->
@@ -57,7 +57,7 @@
<xsl:attribute name="margin-right">0in</xsl:attribute>
<xsl:attribute name="background-repeat">no-repeat</xsl:attribute>
<xsl:attribute name="background-image">
- <xsl:value-of select="concat( $FDPDIR, '/docs-common/stylesheet-images/titlepage.png' )"/>
+ <xsl:value-of select="concat( $FDPCOMMONDIR, '/stylesheet-images/titlepage.png' )"/>
</xsl:attribute>
</xsl:element>
<fo:region-before extent="0pt" display-align="after" region-name="xsl-region-before-first"/>
17 years, 1 month
docs-common/packaging bookinfo.xsl, 1.29, 1.30 insert-changelog.xsl, 1.7, 1.8
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/docs-common/packaging
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv12620/packaging
Modified Files:
bookinfo.xsl insert-changelog.xsl
Log Message:
Use new rule to locate docs-common and rely on this for most building, instead of a possibly nonexistent FDPDIR. This should make a module inclusion or a full repository checkout equally workable.
Index: bookinfo.xsl
===================================================================
RCS file: /cvs/docs/docs-common/packaging/bookinfo.xsl,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- bookinfo.xsl 25 Nov 2006 01:24:43 -0000 1.29
+++ bookinfo.xsl 12 Mar 2007 00:08:35 -0000 1.30
@@ -4,7 +4,7 @@
<xsl:param name="lang" select="'en'"/>
<xsl:param name="doctype" select="'bookinfo'"/>
<xsl:param name="who" select="''"/>
- <xsl:param name="fdpdir" select="'../..'"/>
+ <xsl:param name="fdpcommondir" select="'..'"/>
<xsl:param name="legalbase" select="'legalnotice-opl'"/>
<xsl:output encoding="UTF-8" indent="yes" method="xml"
@@ -71,7 +71,7 @@
<xsl:element name="xi:include"
namespace="http://www.w3.org/2001/XInclude"><xsl:attribute
name="href"><xsl:value-of
- select="$fdpdir"/>/docs-common/common/<xsl:value-of
+ select="$fdpcommondir"/>/common/<xsl:value-of
select="$legalbase"/>-<xsl:value-of
select="$lang"/>.xml</xsl:attribute></xsl:element>
</xsl:when>
@@ -79,7 +79,7 @@
<xsl:element name="xi:include"
namespace="http://www.w3.org/2001/XInclude"><xsl:attribute
name="href"><xsl:value-of
- select="$fdpdir"/>/docs-common/common/legalnotice-<xsl:value-of
+ select="$fdpcommondir"/>/common/legalnotice-<xsl:value-of
select="$lang"/>.xml</xsl:attribute></xsl:element>
</xsl:otherwise>
</xsl:choose>
Index: insert-changelog.xsl
===================================================================
RCS file: /cvs/docs/docs-common/packaging/insert-changelog.xsl,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- insert-changelog.xsl 11 Mar 2007 20:43:13 -0000 1.7
+++ insert-changelog.xsl 12 Mar 2007 00:08:35 -0000 1.8
@@ -16,11 +16,11 @@
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
- <xsl:param name="fdpdir" select="'../..'"/>
+ <xsl:param name="fdpcommondir" select="'..'"/>
<xsl:output encoding="UTF-8" indent="yes" method="xml"
omit-xml-declaration="no" standalone="no" version="1.0"
- doctype-system="{$fdpdir}/docs-common/packaging/rpm-info.dtd"/>
+ doctype-system="{$fdpcommondir}/packaging/rpm-info.dtd"/>
<xsl:template match="/">
<xsl:apply-templates/>
17 years, 1 month
docs-common Makefile.common,1.144,1.145
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/docs-common
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv12620
Modified Files:
Makefile.common
Log Message:
Use new rule to locate docs-common and rely on this for most building, instead of a possibly nonexistent FDPDIR. This should make a module inclusion or a full repository checkout equally workable.
Index: Makefile.common
===================================================================
RCS file: /cvs/docs/docs-common/Makefile.common,v
retrieving revision 1.144
retrieving revision 1.145
diff -u -r1.144 -r1.145
--- Makefile.common 18 Feb 2007 20:04:04 -0000 1.144
+++ Makefile.common 12 Mar 2007 00:08:35 -0000 1.145
@@ -76,23 +76,30 @@
#########################################################################
# Supply default values for the boilerplate files _unless_ the user has
# provided their own values.
+define find-common-dir
+for d in $(PWD)/docs-common $(PWD)/../docs-common $(PWD)/../../docs-common \
+ /usr/share/fedora/doc/docs-common ; do \
+if [ -f $$d/Makefile.common ] ; then echo "$$d"; break; fi; done
+endef
+FDPCOMMONDIR := $(shell $(find-common-dir))
+# FDPDIR may no longer be required.
ifeq "${FDPDIR}" ""
-FDPDIR = $(PWD)/..
+FDPDIR = ${FDPCOMMONDIR}/..
endif
ifeq "${FDPBIN}" ""
-FDPBIN = ${FDPDIR}/docs-common/bin
+FDPBIN = ${FDPCOMMONDIR}/bin
endif
ifeq "${XSLPDF}" ""
-XSLPDF = ${FDPDIR}/docs-common/xsl/main-pdf.xsl
+XSLPDF = ${FDPCOMMONDIR}/xsl/main-pdf.xsl
endif
ifeq "${XSLHTML}" ""
-XSLHTML = ${FDPDIR}/docs-common/xsl/main-html.xsl
+XSLHTML = ${FDPCOMMONDIR}/xsl/main-html.xsl
endif
ifeq "${XSLHTMLNOCHUNKS}" ""
-XSLHTMLNOCHUNKS = ${FDPDIR}/docs-common/xsl/main-html-nochunks.xsl
+XSLHTMLNOCHUNKS = ${FDPCOMMONDIR}/xsl/main-html-nochunks.xsl
endif
ifeq "${HTMLCSS}" ""
-HTMLCSS = ${FDPDIR}/docs-common/css/fedora-draft.css
+HTMLCSS = ${FDPCOMMONDIR}/css/fedora-draft.css
endif
ifeq "${DRAFT}" ""
#DRAFT = no
@@ -126,7 +133,7 @@
XMLTO =xmlto
XSLTPROC=xsltproc
XMLFORMAT=xmlformat
-XMLFOPTS=-f $(FDPDIR)/docs-common/bin/xmlformat-fdp.conf
+XMLFOPTS=-f $(FDPCOMMONDIR)/bin/xmlformat-fdp.conf
XMLLINT =xmllint
XML2PO =xml2po
XML2POFLAGS=-e
@@ -148,7 +155,7 @@
%.ent: %.xml
${XSLTPROC} -o $@ --stringparam FDPCOMMONDIR "NONE" \
- ${FDPDIR}/docs-common/common/entities/entities.xsl $<
+ ${FDPCOMMONDIR}/common/entities/entities.xsl $<
#########################################################################
#########################################################################
@@ -364,7 +371,7 @@
${PRI_LANG}/${PKGNAME}.omf.in:: ${PRI_LANG}/${RPMINFO}
${XSLTPROC} --stringparam lang ${PRI_LANG} \
--stringparam docbase ${PKGNAME} \
- ${FDPDIR}/docs-common/packaging/omf-in.xsl \
+ ${FDPCOMMONDIR}/packaging/omf-in.xsl \
$< > $@
endif
endif
@@ -595,11 +602,11 @@
# mydoc-en/index.html:: mydoc-en.xml ${XMLEXTRAFILES}-en
# LANG=en.UTF-8 ${XMLTO} html -x $(XSLHTML) -o mydoc-en mydoc-en.xml
# mkdir -p mydoc-en/stylesheet-images
-# cp ${FDPDIR}/docs-common/stylesheet-images/*.png mydoc-en/stylesheet-images/
+# cp ${FDPCOMMONDIR}/stylesheet-images/*.png mydoc-en/stylesheet-images/
# cp ${HTMLCSS} mydoc-en/fedora.css
# cp ${HTMLCSSEXTRA} mydoc-en/watermark.png
-# cp ${FDPDIR}/docs-common/images/watermark.png mydoc-en/
-# ${FDPDIR}/docs-common/bin/copy-figs -f '*.png' figs mydoc-en/
+# cp ${FDPCOMMONDIR}/images/watermark.png mydoc-en/
+# ${FDPCOMMONDIR}/bin/copy-figs -f '*.png' figs mydoc-en/
# but we do avoid copying EPS files since they are nonsense to the HTML world.
#
define HTML_template
@@ -608,10 +615,10 @@
${DOCBASE}-$(1)/index.html:: ${XMLFILES-${1}} ${XMLDEPFILES-${1}}
LANG=$(1).UTF-8 ${XMLTO} html -x $(XSLHTML) -o $(DOCBASE)-$(1) $(1)/$(DOCBASE).xml
mkdir -p $(DOCBASE)-$(1)/stylesheet-images/
- cp ${FDPDIR}/docs-common/stylesheet-images/*.png $(DOCBASE)-$(1)/stylesheet-images
+ cp ${FDPCOMMONDIR}/stylesheet-images/*.png $(DOCBASE)-$(1)/stylesheet-images
cp ${HTMLCSS} $(DOCBASE)-$(1)/fedora.css
ifneq "${DRAFT}" "no"
- cp ${FDPDIR}/docs-common/images/watermark-$(1).png \
+ cp ${FDPCOMMONDIR}/images/watermark-$(1).png \
$(DOCBASE)-$(1)/watermark.png
endif
[ ! -d figs ] || copy-figs -v -f '*.png' \
@@ -644,10 +651,10 @@
LANG=${1}.UTF-8 ${XMLTO} html-nochunks -x $(XSLHTMLNOCHUNKS) $(1)/$(DOCBASE).xml
mv $(DOCBASE).html $(DOCBASE)-$(1).html
mkdir -p stylesheet-images/
- cp ${FDPDIR}/docs-common/stylesheet-images/*.png stylesheet-images/
+ cp ${FDPCOMMONDIR}/stylesheet-images/*.png stylesheet-images/
cp ${HTMLCSS} fedora.css
ifneq "${DRAFT}" "no"
- cp ${FDPDIR}/docs-common/images/watermark-$(1).png watermark.png
+ cp ${FDPCOMMONDIR}/images/watermark-$(1).png watermark.png
endif
distclean::
@@ -700,7 +707,7 @@
fo-${1}:: ${1}/${DOCBASE}.fo
${1}/${DOCBASE}.fo:: ${XMLFILES-${1}} ${XMLDEPFILES-${1}}
LANG=${1}.UTF-8 xsltproc --xinclude \
- --stringparam FDPDIR ${FDPDIR} \
+ --stringparam FDPCOMMONDIR ${FDPCOMMONDIR} \
--stringparam IMGROOT ${PWD} \
--stringparam RENDEREDBY fop-0.20.5 \
${XSLPDF} ${1}/${DOCBASE}.xml | ${XMLLINT} --format -o $$@ -
@@ -750,7 +757,7 @@
${DOCBASE}-$(1).txt:: ${XMLFILES-${1}} ${XMLDEPFILES-${1}}
${XMLLINT} ${XMLLINTOPT} $(1)/$(DOCBASE).xml > $(1)/$(DOCBASE).lint.xml
- ${XSLTPROC} $(FDPDIR)/docs-common/packaging/strip-for-txt.xsl \
+ ${XSLTPROC} $(FDPCOMMONDIR)/packaging/strip-for-txt.xsl \
$(1)/$(DOCBASE).lint.xml > $(1)/$(DOCBASE).stripped.xml
rm $(1)/$(DOCBASE).lint.xml
LANG=$(1).UTF-8 ${XMLTO} ${XMLTOTXTPOSTOPT} txt $(1)/$(DOCBASE).stripped.xml
@@ -846,11 +853,11 @@
$(1)/fdp-info.xml:: ${1}/$(RPMINFO)
mkdir -p ${1}
LANG=$(1).UTF-8 ${XSLTPROC} --stringparam lang $(1) \
- --stringparam fdpdir $(FDPDIR) \
+ --stringparam fdpcommondir $(FDPCOMMONDIR) \
--stringparam doctype $(shell \
doctype ${PRI_LANG}/$(DOCBASE).xml) \
--stringparam legalbase ${LEGALNOTICEBASE} \
- ${FDPDIR}/docs-common/packaging/bookinfo.xsl \
+ ${FDPCOMMONDIR}/packaging/bookinfo.xsl \
${1}/$(RPMINFO) | \
$(XMLFORMAT) $(XMLFOPTS) >$$@
@@ -971,7 +978,7 @@
fedora-doc-${DOCBASE}-gnome.desktop:: ${RPMINFO}
$(XSLTPROC) --stringparam docbase "${DOCBASE}" \
- ${FDPDIR}/docs-common/packaging/gnome-desktop.xsl \
+ ${FDPCOMMONDIR}/packaging/gnome-desktop.xsl \
${RPMINFO} >$@.tmp && move-if-change $@.tmp $@
help::
@@ -984,7 +991,7 @@
fedora-doc-${DOCBASE}-kde.desktop:: ${RPMINFO}
$(XSLTPROC) --stringparam docbase "${DOCBASE}" \
- ${FDPDIR}/docs-common/packaging/kde-desktop.xsl \
+ ${FDPCOMMONDIR}/packaging/kde-desktop.xsl \
${RPMINFO} >$@.tmp && move-if-change $@.tmp $@
help::
@@ -997,16 +1004,16 @@
fedora-doc-${DOCBASE}-khelp.desktop:: ${RPMINFO}
$(XSLTPROC) --stringparam docbase "${DOCBASE}" \
- ${FDPDIR}/docs-common/packaging/khelpcenter-plugin.xsl \
+ ${FDPCOMMONDIR}/packaging/khelpcenter-plugin.xsl \
${RPMINFO} >$@.tmp && move-if-change $@.tmp $@
define FDP_ENTITIES_template
-${1}/$${FDP_ENTITIES}:: ${FDPDIR}/docs-common/common/entities/entities-${1}.xml
+${1}/$${FDP_ENTITIES}:: ${FDPCOMMONDIR}/common/entities/entities-${1}.xml
mkdir -p ${1}
- xsltproc --stringparam FDPCOMMONDIR "${FDPDIR}/docs-common/common" \
- $${FDPDIR}/docs-common/common/entities/entities.xsl \
- $${FDPDIR}/docs-common/common/entities/entities-${1}.xml \
+ xsltproc --stringparam FDPCOMMONDIR "${FDPCOMMONDIR}/common" \
+ $${FDPCOMMONDIR}/common/entities/entities.xsl \
+ $${FDPCOMMONDIR}/common/entities/entities-${1}.xml \
>$$@.tmp && move-if-change $$@.tmp $$@
clean::
17 years, 1 month
documentation-guide acknowledgments-zh_CN.xml, 1.2, NONE docs-emacs-nxml-zh_CN.xml, 1.1, NONE docs-emacs-zh_CN.xml, 1.2, NONE docs-getting-files-zh_CN.xml, 1.2, NONE docs-intro-zh_CN.xml, 1.2, NONE docs-rh-guidelines-zh_CN.xml, 1.2, NONE docs-style-zh_CN.xml, 1.1, NONE docs-tutorial-zh_CN.xml, 1.3, NONE docs-vim-zh_CN.xml, 1.2, NONE docs-xml-tags-zh_CN.xml, 1.2, NONE documentation-guide-zh_CN.xml, 1.3, NONE
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/documentation-guide
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv28783
Removed Files:
acknowledgments-zh_CN.xml docs-emacs-nxml-zh_CN.xml
docs-emacs-zh_CN.xml docs-getting-files-zh_CN.xml
docs-intro-zh_CN.xml docs-rh-guidelines-zh_CN.xml
docs-style-zh_CN.xml docs-tutorial-zh_CN.xml
docs-vim-zh_CN.xml docs-xml-tags-zh_CN.xml
documentation-guide-zh_CN.xml
Log Message:
Remove old and osbsolete zh_CN XML files. Preserve what we can in new PO file, thanks to the genius of xml2po and msgmerge.
--- acknowledgments-zh_CN.xml DELETED ---
--- docs-emacs-nxml-zh_CN.xml DELETED ---
--- docs-emacs-zh_CN.xml DELETED ---
--- docs-getting-files-zh_CN.xml DELETED ---
--- docs-intro-zh_CN.xml DELETED ---
--- docs-rh-guidelines-zh_CN.xml DELETED ---
--- docs-style-zh_CN.xml DELETED ---
--- docs-tutorial-zh_CN.xml DELETED ---
--- docs-vim-zh_CN.xml DELETED ---
--- docs-xml-tags-zh_CN.xml DELETED ---
--- documentation-guide-zh_CN.xml DELETED ---
17 years, 1 month
documentation-guide/po zh_CN.po,NONE,1.1
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/documentation-guide/po
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv28783/po
Added Files:
zh_CN.po
Log Message:
Remove old and osbsolete zh_CN XML files. Preserve what we can in new PO file, thanks to the genius of xml2po and msgmerge.
***** Error reading new file: [Errno 2] No such file or directory: 'zh_CN.po'
17 years, 1 month
docs-common/packaging migrate-rpminfo.xsl,1.1,1.2
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/docs-common/packaging
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv23768/docs-common/packaging
Modified Files:
migrate-rpminfo.xsl
Log Message:
Fix to properly pull only correct details for this $LANG
Index: migrate-rpminfo.xsl
===================================================================
RCS file: /cvs/docs/docs-common/packaging/migrate-rpminfo.xsl,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- migrate-rpminfo.xsl 5 Aug 2006 21:06:08 -0000 1.1
+++ migrate-rpminfo.xsl 11 Mar 2007 20:44:29 -0000 1.2
@@ -50,7 +50,9 @@
<xsl:for-each select="*">
<xsl:choose>
<xsl:when test="name(.)='details'">
- <xsl:call-template name="detailtemplate" />
+ <xsl:if test="@lang=$lang">
+ <xsl:call-template name="detailtemplate" />
+ </xsl:if>
</xsl:when>
<xsl:otherwise>
<xsl:copy-of select="." />
17 years, 1 month
docs-common/packaging insert-changelog.xsl,1.6,1.7
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/docs-common/packaging
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv23719/docs-common/packaging
Modified Files:
insert-changelog.xsl
Log Message:
Adapt to use proper fdpdir location
Index: insert-changelog.xsl
===================================================================
RCS file: /cvs/docs/docs-common/packaging/insert-changelog.xsl,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- insert-changelog.xsl 5 Aug 2006 03:56:35 -0000 1.6
+++ insert-changelog.xsl 11 Mar 2007 20:43:13 -0000 1.7
@@ -16,9 +16,11 @@
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+ <xsl:param name="fdpdir" select="'../..'"/>
+
<xsl:output encoding="UTF-8" indent="yes" method="xml"
omit-xml-declaration="no" standalone="no" version="1.0"
- doctype-system="../docs-common/packaging/rpm-info.dtd"/>
+ doctype-system="{$fdpdir}/docs-common/packaging/rpm-info.dtd"/>
<xsl:template match="/">
<xsl:apply-templates/>
17 years, 1 month
documentation-guide/en_US module-struct.xml,1.2,1.3
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/documentation-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv17851
Modified Files:
module-struct.xml
Log Message:
Yay, segmentedlists for everyone!
Index: module-struct.xml
===================================================================
RCS file: /cvs/docs/documentation-guide/en_US/module-struct.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- module-struct.xml 3 Feb 2007 22:29:37 -0000 1.2
+++ module-struct.xml 9 Mar 2007 01:16:05 -0000 1.3
@@ -41,48 +41,62 @@
|
`-- Makefile]]></computeroutput></screen>
</example>
- <formalpara>
- <title>Primary language directory (required)</title>
- <para>This is the only directory absolutely required. It is named for the
- original language of the document, such as <filename
- class="directory">en_US</filename> (US English). The primary language
- does not have to be US English; all languages are supported. This
- directory contains all the XML source for the actual document, as well
- as XML source for document-specific
- <firstterm>entities</firstterm><footnote>
- <para>Think of an XML entity as a predefined snippet of information.
- It can represent a chunk of XML source, or simply a word or
- character. If the information changes, it need be replaced only
- once, in the definition, to fix all usage.</para>
- </footnote>.
- </para>
- </formalpara>
- <formalpara>
- <title>Graphics directory (optional)</title>
- <para>The <filename class="directory">figs/</filename> directory is an
- optional directory where graphics for the document should be stored. If
- graphics are screenshots that are particular to a language, the
- <filename class="directory">figs/</filename> directory can and should be
- stored in a language directory.</para>
- </formalpara>
- <formalpara>
- <title>Translation (PO) directory (optional)</title>
- <para>The <filename class="directory">po/</filename> directory contains
- specially formatted files created and used by translators. The &FDP;
- build tools use these files to create translated versions of documents.
- The translated documents are not stored in CVS; they are created as
- needed from these PO files.</para>
- </formalpara>
- <formalpara>
- <title>Makefile (required)</title>
- <para>The <filename>Makefile</filename> controls the build process. Its
- content is discussed in <xref linkend="ex-makefile"/>.</para>
- </formalpara>
- <formalpara>
- <title><filename>rpm-info.xml</filename> (required)</title>
- <para>The <filename>rpm-info.xml</filename> file contains document
- specific metadata</para>
- </formalpara>
+ <segmentedlist id="sg-module-contents">
+ <title>CVS Module Contents</title>
+ <segtitle>Component</segtitle>
+ <segtitle>Type</segtitle>
+ <segtitle>Usage Notes</segtitle>
+ <seglistitem>
+ <seg>Primary language directory</seg>
+ <seg>required</seg>
+ <seg>This is the only directory absolutely required. It is named
+ for the original language of the document, such as <filename
+ class="directory">en_US</filename> (US English). The
+ primary language does not have to be US English; all languages
+ are supported. This directory contains all the XML source for
+ the actual document, as well as XML source for
+ document-specific <firstterm>entities</firstterm><footnote>
+ <para>Think of an XML entity as a predefined snippet of
+ information. It can represent a chunk of XML source, or
+ simply a word or character. If the information changes, it
+ need be replaced only once, in the definition, to fix all
+ usage.</para>
+ </footnote>.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>Graphics directory</seg>
+ <seg>optional</seg>
+ <seg>The <filename class="directory">figs/</filename> directory
+ is an optional directory where graphics for the document
+ should be stored. If graphics are screenshots that are
+ particular to a language, the <filename
+ class="directory">figs/</filename> directory can and should
+ be stored in a language directory.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>Translation (PO) directory</seg>
+ <seg>optional</seg>
+ <seg>The <filename class="directory">po/</filename> directory
+ contains specially formatted files created and used by
+ translators. The &FDP; build tools use these files to create
+ translated versions of documents. The translated documents are
+ not stored in CVS; they are created as needed from these PO
+ files.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg>Makefile</seg>
+ <seg>required</seg>
+ <seg>The <filename>Makefile</filename> controls the build
+ process. Its content is discussed in <xref
+ linkend="ex-makefile"/>.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><filename>rpm-info.xml</filename></seg>
+ <seg>required</seg>
+ <seg>The <filename>rpm-info.xml</filename> file contains
+ document specific metadata</seg>
+ </seglistitem>
+ </segmentedlist>
</section>
<section id="ch-getting-files-build-system">
<title>The Document Build System</title>
@@ -109,7 +123,7 @@
<example id="ex-makefile">
<title>Sample Document Makefile</title>
<programlisting><![CDATA[DOCBASE = example-doc
-PRI_LANG = en_US
+PRI_LANG = en_US
OTHERS = de pt
DOC_ENTITIES = doc-entities
@@ -125,48 +139,54 @@
such as the <command>XMLFILES_template</command> stanza. An
explanation for this template appears a few paragraphs
below.</para>
- <formalpara>
- <title><systemitem class="macro">DOCBASE</systemitem></title>
- <para>This variable contains the name for the main (parent) XML
- document. Follow convention by naming your document after the
- module name.</para>
- </formalpara>
- <formalpara>
- <title><systemitem class="macro">PRI_LANG</systemitem></title>
- <para>This variable contains the ISO code for the original
- version of the document, such as
- <systemitem>en_US</systemitem>.</para>
- </formalpara>
- <formalpara>
- <title><systemitem class="macro">OTHERS</systemitem></title>
- <para>This variable contains a listing of ISO codes for any
- other versions into which the document has been translated.
- The module must contain a <filename
- class="directory">po/</filename> directory and a PO file for
- any indicated additional languages.</para>
- </formalpara>
- <formalpara>
- <title><systemitem class="macro">DOC_ENTITIES</systemitem></title>
- <para>This variable contains a listing of any files containing
- entity definitions. The &FDP; uses a special XML format to
- record document-specific entities, so they can be translated and
- built on the fly like any other XML document. An example is
- shown later in this guide. <!-- need xref here --></para>
- </formalpara>
- <formalpara>
- <title><systemitem
- class="macro">XMLFILES_template</systemitem></title>
- <para>This template allows the build tools to work with the
- document in multiple languages once it is translated. The
- <systemitem class="macro">${1}</systemitem> marking is a
- variable used to substitute the appropriate language. This
- template is not terribly complicated. For a new module,
- duplicate this section exactly except for the actual
- filenames. Prepend the text <systemitem
- class="macro">${1}/</systemitem>, in place of the language
- code directory name, to each filename in your document.
- </para>
- </formalpara>
+ <segmentedlist id="sg-makefile-variables">
+ <title>Makefile Variables</title>
+ <segtitle>Variable</segtitle>
+ <segtitle>Explanation</segtitle>
+ <seglistitem>
+ <seg><systemitem class="macro">DOCBASE</systemitem></seg>
+ <seg>This variable contains the name for the main (parent) XML
+ document. Follow convention by naming your document after
+ the module name.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">PRI_LANG</systemitem></seg>
+ <seg>This variable contains the ISO code for the original
+ version of the document, such as
+ <systemitem>en_US</systemitem>.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">OTHERS</systemitem></seg>
+ <seg>This variable contains a listing of ISO codes for any
+ other versions into which the document has been translated.
+ The module must contain a <filename
+ class="directory">po/</filename> directory and a PO file
+ for any indicated additional languages.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">DOC_ENTITIES</systemitem></seg>
+ <seg>This variable contains a listing of any files containing
+ entity definitions. The &FDP; uses a special XML format to
+ record document-specific entities, so they can be translated
+ and built on the fly like any other XML document. An
+ example is shown later in this guide. <!-- need xref here
+ --></seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem
+ class="macro">XMLFILES_template</systemitem></seg>
+ <seg>This template allows the build tools to work with the
+ document in multiple languages once it is translated. The
+ <systemitem class="macro">${1}</systemitem> marking is a
+ variable used to substitute the appropriate language. This
+ template is not terribly complicated. For a new module,
+ duplicate this section exactly except for the actual
+ filenames. Prepend the text <systemitem
+ class="macro">${1}/</systemitem>, in place of the language
+ code directory name, to each filename in your document.
+ </seg>
+ </seglistitem>
+ </segmentedlist>
<important>
<title>Files Exempt From Listing</title>
<para>Do not include the document-specific entities XML file or
@@ -233,54 +253,59 @@
To render the <abbrev>XML</abbrev> document into another format,
use one of the following <command>make</command> targets:
</para>
- <formalpara>
- <title><systemitem class="macro">html</systemitem></title>
- <para>This target builds the "chunked" <abbrev>HTML</abbrev>
- document for each defined translation. Output is placed in a
- separate directory named <filename class="directory"><systemitem
- class="macro">${DOCBASE}</systemitem>-<systemitem
- class="macro">${LANG}</systemitem>/</filename>. Each
- document section is a separate file within that
- directory.</para>
- </formalpara>
- <formalpara>
- <title><systemitem
- class="macro">html-nochunks</systemitem></title>
- <para>This target builds the "non-chunked" <abbrev>HTML</abbrev>
- document for each defined translation. Output is placed in a
- single file: <filename><systemitem
- class="macro">${DOCBASE}</systemitem>-<systemitem
- class="macro">${LANG}</systemitem>.html</filename>; no other
- files are created.</para>
- </formalpara>
- <formalpara>
- <title><systemitem class="macro">pdf</systemitem></title>
- <para>This target builds only the <abbrev>PDF</abbrev> document
- for all document languages. <abbrev>PDF</abbrev> production is
- currently erratic and may not work for your document.</para>
- </formalpara>
- <formalpara>
- <title><systemitem class="macro">tarball</systemitem></title>
- <para>This target builds only the <command>tar(1)</command>
- archive for all document languages.</para>
- </formalpara>
- <formalpara>
- <title><systemitem class="macro">all</systemitem></title>
- <para>This target builds all targets listed above.</para>
- </formalpara>
- <formalpara>
- <title><systemitem class="macro">clean</systemitem></title>
- <para>This target deletes any temporary, or generated files, but
- does <emphasis>not</emphasis> erase any <abbrev>HTML</abbrev>,
- <abbrev>PDF</abbrev>, or archive files.</para>
- </formalpara>
- <formalpara>
- <title><systemitem class="macro">distclean</systemitem></title>
- <para>This target erases all <abbrev>HTML</abbrev>,
- <abbrev>PDF</abbrev>, and archive files. This target
- automatically invokes the <filename>clean</filename> target as
- well.</para>
- </formalpara>
+ <segmentedlist>
+ <title>Build Targets</title>
+ <segtitle>Target</segtitle>
+ <segtitle>Explanation</segtitle>
+ <seglistitem>
+ <seg><systemitem class="macro">html</systemitem></seg>
+ <seg>This target builds the "chunked" <abbrev>HTML</abbrev>
+ document for each defined translation. Output is placed in a
+ separate directory named <filename
+ class="directory"><systemitem
+ class="macro">${DOCBASE}</systemitem>-<systemitem
+ class="macro">${LANG}</systemitem>/</filename>. Each
+ document section is a separate file within that
+ directory.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">html-nochunks</systemitem></seg>
+ <seg>This target builds the "non-chunked" <abbrev>HTML</abbrev>
+ document for each defined translation. Output is placed in a
+ single file: <filename><systemitem
+ class="macro">${DOCBASE}</systemitem>-<systemitem
+ class="macro">${LANG}</systemitem>.html</filename>; no
+ other files are created.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">pdf</systemitem></seg>
+ <seg>This target builds only the <abbrev>PDF</abbrev> document
+ for all document languages. <abbrev>PDF</abbrev> production is
+ currently erratic and may not work for your document.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">tarball</systemitem></seg>
+ <seg>This target builds only the <command>tar(1)</command>
+ archive for all document languages.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">all</systemitem></seg>
+ <seg>This target builds all targets listed above.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">clean</systemitem></seg>
+ <seg>This target deletes any temporary, or generated files, but
+ does <emphasis>not</emphasis> erase any <abbrev>HTML</abbrev>,
+ <abbrev>PDF</abbrev>, or archive files.</seg>
+ </seglistitem>
+ <seglistitem>
+ <seg><systemitem class="macro">distclean</systemitem></seg>
+ <seg>This target erases all <abbrev>HTML</abbrev>,
+ <abbrev>PDF</abbrev>, and archive files. This target
+ automatically invokes the <filename>clean</filename> target as
+ well.</seg>
+ </seglistitem>
+ </segmentedlist>
<section>
<title>Adding or Changing Targets</title>
<para>
17 years, 1 month
docs-common/css fedora-draft.css,1.8,1.9 fedora-plain.css,1.7,1.8
by fedora-docs-commits@redhat.com
Author: pfrields
Update of /cvs/docs/docs-common/css
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv17741
Modified Files:
fedora-draft.css fedora-plain.css
Log Message:
Leave more spacing around table, and style title appropriately
Index: fedora-draft.css
===================================================================
RCS file: /cvs/docs/docs-common/css/fedora-draft.css,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- fedora-draft.css 5 Mar 2007 01:47:16 -0000 1.8
+++ fedora-draft.css 9 Mar 2007 01:01:59 -0000 1.9
@@ -86,8 +86,14 @@
.segmentedlist {
}
+.segmentedlist .title {
+ font-weight: bold;
+ margin-bottom: 0.5em;
+ margin-top: 1.5em;
+}
.segmentedlist table {
border-collapse: collapse;
+ margin-bottom: 2em;
}
.segmentedlist tr {
border: 1px solid #22437f;
@@ -99,10 +105,10 @@
}
.segmentedlist th {
text-align: left;
- padding: 0.2em 5em 0.2em 0.5em;
+ padding: 0.5em 5em 0.5em 0.5em;
}
.segmentedlist td {
- padding: 0.2em 5em 0.2em 0.5em;
+ padding: 0.5em 5em 0.5em 0.5em;
}
hr {
Index: fedora-plain.css
===================================================================
RCS file: /cvs/docs/docs-common/css/fedora-plain.css,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- fedora-plain.css 5 Mar 2007 01:47:16 -0000 1.7
+++ fedora-plain.css 9 Mar 2007 01:01:59 -0000 1.8
@@ -84,8 +84,14 @@
.segmentedlist {
}
+.segmentedlist .title {
+ font-weight: bold;
+ margin-bottom: 0.5em;
+ margin-top: 1.5em;
+}
.segmentedlist table {
border-collapse: collapse;
+ margin-bottom: 2em;
}
.segmentedlist tr {
border: 1px solid #22437f;
@@ -97,10 +103,10 @@
}
.segmentedlist th {
text-align: left;
- padding: 0.2em 5em 0.2em 0.5em;
+ padding: 0.5em 5em 0.5em 0.5em;
}
.segmentedlist td {
- padding: 0.2em 5em 0.2em 0.5em;
+ padding: 0.5em 5em 0.5em 0.5em;
}
hr {
17 years, 1 month