Context Navigation

← Previous Changeset
Next Changeset →

Changeset 3237

Timestamp:

Apr 11, 2007, 4:32:15 PM (16 years ago)

Author:

Martin Svensson

Message:

Organized the chunked html files into subdirectories. The main file, 'index.html', is now located in doc/docbook/html/ when the
documentation has been generated. The subdirectories is named after the part or chapter that is inside.

Location:

trunk

Files:

: 32 edited

build.xml (modified) (2 diffs)
doc/src/docbook/admindoc/adding_user_group_roles.xml (modified) (1 diff)
doc/src/docbook/admindoc/index.xml (modified) (1 diff)
doc/src/docbook/admindoc/installation_upgrade.xml (modified) (1 diff)
doc/src/docbook/admindoc/plugin_installation.xml (modified) (1 diff)
doc/src/docbook/developerdoc/api_overview.xml (modified) (1 diff)
doc/src/docbook/developerdoc/base_overview.xml (modified) (1 diff)
doc/src/docbook/developerdoc/core_ref.xml (modified) (1 diff)
doc/src/docbook/developerdoc/index.xml (modified) (1 diff)
doc/src/docbook/developerdoc/javadoc.xml (modified) (1 diff)
doc/src/docbook/developerdoc/plugin_developer.xml (modified) (1 diff)
doc/src/docbook/developerdoc/write_docbook_doc.xml (modified) (2 diffs)
doc/src/docbook/overviewdoc/base_overview.xml (modified) (1 diff)
doc/src/docbook/overviewdoc/index.xml (modified) (1 diff)
doc/src/docbook/overviewdoc/why_base.xml (modified) (1 diff)
doc/src/docbook/userdoc/about.xml (modified) (1 diff)
doc/src/docbook/userdoc/annotations.xml (modified) (1 diff)
doc/src/docbook/userdoc/array_lims.xml (modified) (1 diff)
doc/src/docbook/userdoc/biomaterials.xml (modified) (1 diff)
doc/src/docbook/userdoc/experiments_analysis.xml (modified) (1 diff)
doc/src/docbook/userdoc/file_system.xml (modified) (1 diff)
doc/src/docbook/userdoc/hardware.xml (modified) (1 diff)
doc/src/docbook/userdoc/import_export_data.xml (modified) (1 diff)
doc/src/docbook/userdoc/index.xml (modified) (1 diff)
doc/src/docbook/userdoc/jobs.xml (modified) (1 diff)
doc/src/docbook/userdoc/project_permission.xml (modified) (1 diff)
doc/src/docbook/userdoc/protocols.xml (modified) (1 diff)
doc/src/docbook/userdoc/reporters.xml (modified) (1 diff)
doc/src/docbook/userdoc/software.xml (modified) (1 diff)
doc/src/docbook/userdoc/trashcan.xml (modified) (1 diff)
doc/src/docbook/userdoc/webclient.xml (modified) (1 diff)
lib/docbook/custom-styles/docbook/plain/xsl/customized.chunked.xsl (modified) (2 diffs)

Legend:

: Unmodified
: Added
: Removed

trunk/build.xml

-                      r3236
+                      r3237
     description="Generate docbook user and admin documentation."
+    >
     <mkdir dir="${doc}/docbook" />
     <mkdir dir="${build}/docbook" />
+    <mkdir dir="${doc}/docbook/html" />
+    <mkdir dir="${build}/docbook/" />
     <delete description="Delete existing documents">
       <fileset dir="${build}/docbook" defaultexcludes="no" />
 …
       <property name="docbook.xml.dir" location="${docbook.src}" />
       <property name="docbook.resources.dir" location="${docbook.src}/figures" />
       <property name="distribution.dir" location="${doc}/docbook" />
+      <property name="distribution.dir" location="${doc}/docbook/html" />
       <property name="build.dir" location="${build}/docbook" />
       <property name="base.version" value="${base.version}"/>

trunk/doc/src/docbook/admindoc/adding_user_group_roles.xml

r3192	r3237
28	28
29	29	<chapter id="adding_user_group_roles">
	30	<?dbhtml dir="adding_user_group_roles"?>
30	31	<title>Adding users, groups and roles</title>
31	32	<sect1>

trunk/doc/src/docbook/admindoc/index.xml

r3192	r3237
27	27	-->
28	28	<part id="admindoc">
	29	<?dbhtml dir="admindoc"?>
29	30	<title>Admin documentation</title>
30	31	<include file="installation_upgrade.xml"/>

trunk/doc/src/docbook/admindoc/installation_upgrade.xml

r3234	r3237
28	28
29	29	<chapter id="installation_upgrade">
	30	<?dbhtml dir="installation_upgrade"?>
30	31
31	32	<title>Installation, migration, and upgrade instructions</title>

trunk/doc/src/docbook/admindoc/plugin_installation.xml

r3192	r3237
28	28
29	29	<chapter id="plugin_installation">
	30	<?dbhtml dir="plugin_installation"?>
30	31	<title id="plugin_installation.title">Installing plugins</title>
31	32

trunk/doc/src/docbook/developerdoc/api_overview.xml

r3192	r3237
28	28
29	29	<chapter id="api_overview">
	30	<?dbhtml dir="api"?>
30	31	<title>API overview (how to use and code examples)</title>
31	32	<sect1>

trunk/doc/src/docbook/developerdoc/base_overview.xml

r3235	r3237
28	28
29	29	<chapter id="base_develop_overview">
	30	<?dbhtml dir="develop_overview"?>
30	31	<title>Overview of BASE2</title>
31	32	<sect1>

trunk/doc/src/docbook/developerdoc/core_ref.xml

r3192	r3237
28	28
29	29	<chapter id="core_ref">
	30	<?dbhtml dir="core_ref"?>
30	31	<title>Core developer reference</title>
31	32	<sect1>

trunk/doc/src/docbook/developerdoc/index.xml

r3225	r3237
27	27	-->
28	28	<part id="developerdoc">
	29	<?dbhtml dir="developerdoc"?>
29	30	<title>Developer documentation</title>
30	31	<include file="base_overview.xml"/>

trunk/doc/src/docbook/developerdoc/javadoc.xml

r3192	r3237
28	28
29	29	<chapter id="javadoc">
	30	<?dbhtml dir="javadoc"?>
30	31	<title>Javadoc</title>
31	32	<sect1>

trunk/doc/src/docbook/developerdoc/plugin_developer.xml

r3192	r3237
28	28
29	29	<chapter id="plugin_developer">
	30	<?dbhtml dir="plugin_developer"?>
30	31	<title>Plugin developer</title>
31	32	<sect1 id="plugin_developer.organize">

trunk/doc/src/docbook/developerdoc/write_docbook_doc.xml

-                      r3233
+                      r3237
 <chapter id="write_docbook_doc">
+  <title>How to use docbook</title>
+  <?dbhtml dir="write_doc"?>
+  <title>Write documentation</title>
   <para>
     This chapter is for those who intent to contribute to the BASE2 documentation. The chapter
 …
           <listitem>
             <para>
+              This is not implemented yet, cf. <ulink url="http://base.thep.lu.se/ticket/521">http://base.thep.lu.se/ticket/521</ulink>
+              This is not completely implemented yet, cf. <ulink url="http://base.thep.lu.se/ticket/521">http://base.thep.lu.se/ticket/521</ulink>
+            </para>
+            <para>
+               For now the pdf document is generated  at the same time as the html-pages.
+               The file, <filename class='headerfile'>base_{baseversion}.pdf</filename>
+               can  be found in
+              <filename class="directory">base2root/doc/docbook/</filename>, just
+              like the main html-file.
             </para>
           </listitem>

trunk/doc/src/docbook/overviewdoc/base_overview.xml

r3192	r3237
28	28
29	29	<chapter id="base_overview">
	30	<?dbhtml dir="overview"?>
30	31	<title>Overview of BASE2</title>
31	32	<sect1>

trunk/doc/src/docbook/overviewdoc/index.xml

r3192	r3237
27	27	-->
28	28	<part id="overviewdoc">
	29	<?dbhtml dir="overviewdoc"?>
29	30	<title>Overview</title>
30	31	<include file="why_base.xml"/>

trunk/doc/src/docbook/overviewdoc/why_base.xml

r3192	r3237
28	28
29	29	<chapter id="why_base">
	30	<?dbhtml dir="why_base"?>
30	31	<title>Why use BASE2</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/about.xml

r3192	r3237
28	28
29	29	<chapter id="about">
	30	<?dbhtml dir="about"?>
30	31	<title>About this part</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/annotations.xml

r3192	r3237
28	28
29	29	<chapter id="annotations">
	30	<?dbhtml dir="annotations"?>
30	31	<title>Annotations</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/array_lims.xml

r3192	r3237
28	28
29	29	<chapter id="array_lims">
	30	<?dbhtml dir="array_lims"?>
30	31	<title>Array LIMS</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/biomaterials.xml

r3192	r3237
28	28
29	29	<chapter id="biomaterials">
	30	<?dbhtml dir="biomaterials"?>
30	31	<title>Biomaterials</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/experiments_analysis.xml

r3192	r3237
28	28
29	29	<chapter id="experiments_analysis">
	30	<?dbhtml dir="analysis"?>
30	31	<title>Experiments and analysis</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/file_system.xml

r3224	r3237
28	28
29	29	<chapter id="file_system">
	30	<?dbhtml dir="filesystem"?>
30	31	<title>File management</title>
31	32	<sect1 id="file_system.system">

trunk/doc/src/docbook/userdoc/hardware.xml

r3192	r3237
28	28
29	29	<chapter id="hardware">
	30	<?dbhtml dir="hardware"?>
30	31	<title>Hardware</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/import_export_data.xml

r3215	r3237
28	28
29	29	<chapter id="import_export_data">
	30	<?dbhtml dir="import_export"?>
30	31	<title>Import and export of data</title>
31	32	<para>

trunk/doc/src/docbook/userdoc/index.xml

r3192	r3237
27	27	-->
28	28	<part id="userdoc">
	29	<?dbhtml dir="userdoc"?>
29	30	<title>User documentation</title>
30	31	<include file= "about.xml"/>

trunk/doc/src/docbook/userdoc/jobs.xml

r3192	r3237
28	28
29	29	<chapter id="jobs">
	30	<?dbhtml dir="jobs"?>
30	31	<title>Jobs</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/project_permission.xml

r3197	r3237
28	28
29	29	<chapter id="project_permission">
	30	<?dbhtml dir="project_permission"?>
30	31	<title>Projects and the permission system</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/protocols.xml

r3192	r3237
28	28
29	29	<chapter id="protocols">
	30	<?dbhtml dir="protocols"?>
30	31	<title>Protocols</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/reporters.xml

r3192	r3237
28	28
29	29	<chapter id="reporters">
	30	<?dbhtml dir="reporter"?>
30	31	<title>Reporters</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/software.xml

r3192	r3237
28	28
29	29	<chapter id="software">
	30	<?dbhtml dir="software"?>
30	31	<title>Software</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/trashcan.xml

r3192	r3237
28	28
29	29	<chapter id="trashcan">
	30	<?dbhtml dir="trashcan"?>
30	31	<title>Trashcan</title>
31	32	<sect1>

trunk/doc/src/docbook/userdoc/webclient.xml

r3221	r3237
28	28
29	29	<chapter id="webclient">
	30	<?dbhtml dir="webclient"?>
30	31	<title>Using the web client</title>
31	32	<sect1 id="webclient.introduction">

trunk/lib/docbook/custom-styles/docbook/plain/xsl/customized.chunked.xsl

-                      r3207
+                      r3237
 <!-- (MM20040315) xsl parameters moved from ant-build-docbook.xml to here -->
 <xsl:param name="table.borders.with.css" select="1"/>
 <xsl:param name="html.stylesheet">css/docbook.css</xsl:param>
+<xsl:param name="html.stylesheet">@base.dir@/css/docbook.css</xsl:param>
 <xsl:param name="html.stylesheet.type">text/css</xsl:param>
 <xsl:param name="section.label.includes.component.label" select="1" />
 …
 <xsl:param name="make.graphic.viewport" select="0"/>
 <xsl:param name="callout.graphics" select="1" />
 <xsl:param name="callout.graphics.path">gfx/admonitions/callouts/</xsl:param>
+<xsl:param name="callout.graphics.path">@base.dir@/gfx/admonitions/callouts/</xsl:param>
 <xsl:param name="callout.graphics.extension">.gif</xsl:param>
 <xsl:param name="admon.graphics" select="1"/>
 <xsl:param name="admon.graphics.path">gfx/admonitions/</xsl:param>
+<xsl:param name="admon.graphics.path">@base.dir@/gfx/admonitions/</xsl:param>
 <xsl:param name="admon.graphics.extension">.gif</xsl:param>
 <xsl:param name="admonition.title.properties">text-align: left</xsl:param>
+<xsl:param name="img.src.path">@base.dir@/</xsl:param>
 <xsl:param name="use.id.as.filename" select="1"/>

Note: See TracChangeset for help on using the changeset viewer.

Context Navigation

Changeset 3237

Legend:

Download in other formats: