You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@velocity.apache.org by he...@apache.org on 2007/09/01 14:33:01 UTC
svn commit: r571786 - in /velocity/docbook/trunk: DBFUserGuide.pdf
build-docbook.xml default_imageincludes.txt
docs/src/docbook/dbf/DBFUserGuide.xml
Author: henning
Date: Sat Sep 1 05:33:01 2007
New Revision: 571786
URL: http://svn.apache.org/viewvc?rev=571786&view=rev
Log:
Apply image inclusion patch contributed by Matthew Koch (DBF-1).
Added:
velocity/docbook/trunk/default_imageincludes.txt (with props)
Modified:
velocity/docbook/trunk/DBFUserGuide.pdf
velocity/docbook/trunk/build-docbook.xml
velocity/docbook/trunk/docs/src/docbook/dbf/DBFUserGuide.xml
Modified: velocity/docbook/trunk/DBFUserGuide.pdf
URL: http://svn.apache.org/viewvc/velocity/docbook/trunk/DBFUserGuide.pdf?rev=571786&r1=571785&r2=571786&view=diff
==============================================================================
Binary files /tmp/tmpO4GWkg and /tmp/tmpP7a_yU differ
Modified: velocity/docbook/trunk/build-docbook.xml
URL: http://svn.apache.org/viewvc/velocity/docbook/trunk/build-docbook.xml?rev=571786&r1=571785&r2=571786&view=diff
==============================================================================
--- velocity/docbook/trunk/build-docbook.xml (original)
+++ velocity/docbook/trunk/build-docbook.xml Sat Sep 1 05:33:01 2007
@@ -130,6 +130,7 @@
<property name="@{type}.tmp.style" value="${tmp.dir}/@{type}.xsl"/>
<property name="@{type}.tmp.custom" value="${tmp.dir}/@{type}-style.xsl"/>
<property name="@{type}.tmp.titlepage" value="${tmp.dir}/@{type}-titlepage"/>
+ <property name="@{type}.tmp.imageincludes" value="${tmp.dir}/@{type}_imageincludes.txt"/>
<path id="@{type}.target.path" location="${@{type}.target.dir}"/>
<pathconvert dirsep="/" property="@{type}.target.path" refid="@{type}.target.path"/>
@@ -161,8 +162,13 @@
output="${@{type}.tmp.titlepage}.xsl"
style="${dbf.xsl.dir}/template/titlepage.xsl"/>
+ <!-- copy custom imageincludes. If we don't have one, use the default one. -->
+ <copy file="${docbook.src.dir}/@{dir}/@{file}.@{type}_imageincludes.txt"
+ tofile="${@{type}.tmp.imageincludes}" overwrite="true" failonerror="false" />
+ <copy file="${dbf.basedir}/default_imageincludes.txt" tofile="${@{type}.tmp.imageincludes}"
+ overwrite="false" failonerror="true" />
<copy todir="${@{type}.target.dir}/images">
- <fileset dir="${images.src.dir}"/>
+ <fileset dir="${images.src.dir}" includesfile="${@{type}.tmp.imageincludes}" />
</copy>
<xalan input="${docbook.src.dir}/@{dir}/@{file}.xml"
@@ -275,8 +281,9 @@
<transform type="html" target="html" title="html" xsl="html" dir="${docbook.dir}" file="${docbook.file}"/>
+ <!-- transform copied the custom or default imageincludes, so use it -->
<copy todir="${html.target.dir}/images">
- <fileset dir="${dbf.xsl.dir}/images/"/>
+ <fileset dir="${dbf.xsl.dir}/images/" includesfile="${tmp.dir}/html_imageincludes.txt"/>
</copy>
<copy todir="${html.target.dir}/css">
@@ -302,8 +309,9 @@
<transform type="htmlsingle" target="htmlsingle" title="html" xsl="html" dir="${docbook.dir}" file="${docbook.file}"/>
+ <!-- transform copied the custom or default imageincludes, so use it -->
<copy todir="${htmlsingle.target.dir}/images">
- <fileset dir="${dbf.xsl.dir}/images/"/>
+ <fileset dir="${dbf.xsl.dir}/images/" includesfile="${tmp.dir}/htmlsingle_imageincludes.txt"/>
</copy>
<copy todir="${htmlsingle.target.dir}/css">
Added: velocity/docbook/trunk/default_imageincludes.txt
URL: http://svn.apache.org/viewvc/velocity/docbook/trunk/default_imageincludes.txt?rev=571786&view=auto
==============================================================================
--- velocity/docbook/trunk/default_imageincludes.txt (added)
+++ velocity/docbook/trunk/default_imageincludes.txt Sat Sep 1 05:33:01 2007
@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# #######################################################################
+#
+# Include all images into the project. This is the default.
+#
+# #######################################################################
+
+**/*
Propchange: velocity/docbook/trunk/default_imageincludes.txt
------------------------------------------------------------------------------
svn:eol-style = native
Modified: velocity/docbook/trunk/docs/src/docbook/dbf/DBFUserGuide.xml
URL: http://svn.apache.org/viewvc/velocity/docbook/trunk/docs/src/docbook/dbf/DBFUserGuide.xml?rev=571786&r1=571785&r2=571786&view=diff
==============================================================================
--- velocity/docbook/trunk/docs/src/docbook/dbf/DBFUserGuide.xml (original)
+++ velocity/docbook/trunk/docs/src/docbook/dbf/DBFUserGuide.xml Sat Sep 1 05:33:01 2007
@@ -29,7 +29,7 @@
<holder>The Apache Software Foundation</holder>
</copyright>
- <releaseinfo>V 1.0</releaseinfo>
+ <releaseinfo>V 1.1-dev</releaseinfo>
<productname>DBF</productname>
@@ -522,8 +522,9 @@
<title>Referencing images</title>
<para>While the docbook files are located in their respective
- subdirectories below src/docbook, your image files should be put into
- the <literal>src/images</literal> directory.</para>
+ subdirectories below <literal>src/docbook</literal>, your
+ image files should be put into the
+ <literal>src/images</literal> directory.</para>
<para>When writing documentation, images are referenced as
<literal>images/<your image file name here></literal> because
@@ -538,6 +539,26 @@
the source directory where your DocBook files reside to the
<literal>src/images</literal> directory.</para>
</warning>
+ </section>
+
+ <section id="selecting-images-for-inclusion">
+ <title>Selecting images for inclusion</title> <para>By
+ default, all docbook images are included along with the images
+ in the <literal>src/images</literal> directory.</para>
+ <para>To explicitly select images for inclusion, you can
+ create a file which contains inclusion patters for an ant
+ fileset<footnote><para>see
+ <uri>http://ant.apache.org/manual/CoreTypes/fileset.html</uri></para></footnote>. This
+ file must be called
+ <literal><projectname>.<output-type>_imageincludes.txt</literal>
+ (for example, the html version of the <literal>foo</literal>
+ project would reference
+ <literal>src/docbook/foo/foo.html_imageincludes.txt</literal>)
+ and it must be located in the
+ <literal>src/docbook/<projectname></literal>
+ directory. This file consists of line delineated file patterns
+ that will be used to match the images to include.</para>
+
</section>
<?hard-pagebreak ?>