[Dotnetmock-commits] dotnetmock/doc .cvsignore,NONE,1.1 build.xml,NONE,1.1 project.properties,NONE,1.1 readme.txt,NONE,1.1

[Choy R. <ch...@us...>]

Update of /cvsroot/dotnetmock/dotnetmock/doc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4090/doc

Added Files:
	.cvsignore build.xml project.properties readme.txt 
Log Message:
Initial skeleton for DotNetMock DocBook documentation.

--- NEW FILE: .cvsignore ---
# $Id: .cvsignore,v 1.1 2005/02/13 10:49:42 choyrim Exp $
output
schema

--- NEW FILE: project.properties ---
# $Id: project.properties,v 1.1 2005/02/13 10:49:42 choyrim Exp $
# Ant properties for building DocBook documentation

# Values in this file will be overriden by any values with the same name
# in the user-created build.properties file.

# ------------------------------------------------------------------------ 
#     docbook reference documentation
# ------------------------------------------------------------------------
doc.output.dir=output

# reference docbook source base directory
doc.ref.dir=reference
# reference docbook output base directory
doc.ref.output.dir=${doc.output.dir}/reference

# docbook libraries and dependencies
docbook.lib.dir=docbook/lib

# the main source code directory for the Spring.NET codebase
src.dir=../src


--- NEW FILE: build.xml ---
<?xml version="1.0"?>

<!--
    Build file for Docbook Documentation

    $Id: build.xml,v 1.1 2005/02/13 10:49:42 choyrim Exp $

    Build file based on build.xml from original Spring Framework, which
		originated from the Hibernate documentation.  Building the documentation
    requires you to download reference/lib from the sourceforge download area.
-->

<project name="DotNetMock DocBook" default="refdoc" basedir=".">
	
  <property file="build.properties" />
  <property file="project.properties" />
	
  <target name="clean" description="Delete output and temporary directories.">
    <delete dir="${basedir}/${doc.output.dir}" />
  </target>

	
  <target name="preparedocs"
	  description="Extra preparation for the documentation (common to all formats)">
	  <!-- no special prep -->
  </target>

  <!-- Extra preparation for HTML documentation -->
  <target name="preparedocshtml">
    <mkdir dir="${basedir}/${doc.ref.output.dir}/styles"/>
    <copy file="${doc.ref.dir}/styles/html.css"
      todir="${basedir}/${doc.ref.output.dir}/styles"/>
  </target>
	
  <target name="docpdf" depends="preparedocs"
      description="Compile reference documentation to pdf">
		
    <antcall target="copycommoncontent">
      <param name="doc.type.output.dir"
          value="${basedir}/${doc.ref.output.dir}/pdf/images"/>
    </antcall>
		
    <java classname="com.icl.saxon.StyleSheet" fork="true"
        dir="${doc.ref.dir}">
      <classpath>
        <fileset dir="${basedir}/${docbook.lib.dir}">
          <include name="**/*.jar" />
        </fileset>
      </classpath>
      <arg value="-o" />
      <arg value="${basedir}/${doc.ref.output.dir}/pdf/docbook_fop.tmp" />
      <arg value="${basedir}/${doc.ref.dir}/src/index.xml" />
      <arg value="${basedir}/${doc.ref.dir}/styles/fopdf.xsl" />
    </java>
		
    <java classname="org.apache.fop.apps.Fop" fork="true"
        dir="${doc.ref.dir}">
      <classpath>
        <fileset dir="${basedir}/${docbook.lib.dir}">
          <include name="**/*.jar" />
        </fileset>
      </classpath>
      <arg value="-d" />
      <arg value="${basedir}/${doc.ref.output.dir}/pdf/docbook_fop.tmp" />
      <arg value="${basedir}/${doc.ref.output.dir}/pdf/dotnetmock-reference.pdf" />
    </java>

    <delete file="${doc.ref.output.dir}/pdf/docbook_fop.tmp" />

  </target>
	
  <target name="dochtml" depends="preparedocs,preparedocshtml"
      description="Compile reference documentation to chunked html">

    <antcall target="copycommoncontent">
      <param name="doc.type.output.dir"
          value="${basedir}/${doc.ref.output.dir}/html/images"/>
    </antcall>
		
    <java classname="com.icl.saxon.StyleSheet" fork="true"
        dir="${doc.ref.output.dir}/html">
      <classpath>
        <fileset dir="${basedir}/${docbook.lib.dir}">
          <include name="**/*.jar" />
        </fileset>
      </classpath>
      <arg value="${basedir}/${doc.ref.dir}/src/index.xml" />
      <arg value="${basedir}/${doc.ref.dir}/styles/html_chunk.xsl" />
    </java>
	
  </target>
	
  <target name="dochtmlsingle" depends="preparedocs,preparedocshtml"
      description="Compile reference documentation to single html">
		
    <antcall target="copycommoncontent">
      <param name="doc.type.output.dir"
          value="${basedir}/${doc.ref.output.dir}/html_single/images"/>
    </antcall>
		
    <java classname="com.icl.saxon.StyleSheet" fork="true"
        dir="${doc.ref.dir}">
      <classpath>
        <fileset dir="${basedir}/${docbook.lib.dir}">
          <include name="**/*.jar" />
        </fileset>
      </classpath>
      <arg value="-o" />
      <arg value="${basedir}/${doc.ref.output.dir}/html_single/index.html" />
      <arg value="${basedir}/${doc.ref.dir}/src/index.xml" />
      <arg value="${basedir}/${doc.ref.dir}/styles/html.xsl" />
    </java>
	
  </target>

  <target name="htmlhelp" depends="preparedocs,preparedocshtml"
      description="Compile reference documentation to MS HTML-HELP">
		
    <antcall target="copycommoncontent">
      <param name="doc.type.output.dir"
          value="${basedir}/${doc.ref.output.dir}/htmlhelp/images"/>
    </antcall>
		
    <java classname="com.icl.saxon.StyleSheet" fork="true"
        dir="${doc.ref.output.dir}/htmlhelp">
      <classpath>
        <fileset dir="${basedir}/${docbook.lib.dir}">
          <include name="**/*.jar" />
        </fileset>
      </classpath>
      <arg value="${basedir}/${doc.ref.dir}/src/index.xml" />
      <arg value="${basedir}/docbook/docbook-xsl-1.67.0/htmlhelp/htmlhelp.xsl" />
    </java>
    <exec dir="${doc.ref.output.dir}/htmlhelp" executable="cmd.exe">
      <arg line="/c hhc htmlhelp.hhp"/>
    </exec>
    <delete includeEmptyDirs="true">
      <fileset dir="${doc.ref.output.dir}/htmlhelp">
        <include name="**/*"/>
        <exclude name="htmlhelp.chm"/>
      </fileset>
    </delete>
    
              
	
  </target>
 
  <!--
  copies content common to all docs to the dir in the ${doc.type.output.dir} property
  -->
  <target name="copycommoncontent">
    <mkdir dir="${doc.type.output.dir}"/>
    <copy todir="${doc.type.output.dir}">
      <fileset dir="${basedir}/${doc.ref.dir}/src/images">
        <include name="*.gif"/>
        <include name="*.svg"/>
        <include name="*.jpg"/>
        <include name="*.png"/>
      </fileset>
    </copy>
  </target>

  <!-- this is the target to call for generating docs for the release -->
  <target name="refdoc" depends="clean,dochtml,htmlhelp,docpdf"
      description="Generate reference documentation"/>
	

</project>


--- NEW FILE: readme.txt ---
This Docbook documentation was taken from the Spring.Java project. The
documentation can be generated using Java Ant. The targets are:

* docpdf        - generates the PDF documentation
* dochtml       - generates the HTML documentation
* dochtmlsingle - generates single page HTML documentation
* clean         - clean any output directories for docs

To generate documentation, you need to include a lot of libraries, which
haven't been added to CVS because they're simply too big. The libraries can
be downloaded from sourceforge or from
http://www.jteam.nl/spring/reference-libraries.zip.  Download them, and
unzip the zip into docbook/lib.  Then, the targets should work.

Thanks to Spring.Java and Hibernate, for providing the skeleton for DocBook
documentation!

ch...@us...