1 <?xml version="1.0" encoding="UTF-8"?>
3 Licensed to the Apache Software Foundation (ASF) under one or more
4 contributor license agreements. See the NOTICE file distributed with
5 this work for additional information regarding copyright ownership.
6 The ASF licenses this file to You under the Apache License, Version 2.0
7 (the "License"); you may not use this file except in compliance with
8 the License. You may obtain a copy of the License at
10 http://www.apache.org/licenses/LICENSE-2.0
12 Unless required by applicable law or agreed to in writing, software
13 distributed under the License is distributed on an "AS IS" BASIS,
14 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 See the License for the specific language governing permissions and
16 limitations under the License.
18 <project name="tomcat-docs" default="build-main" basedir=".">
21 <!-- ===================== Initialize Property Values =================== -->
23 <!-- See "build.properties.sample" in the top level directory for all -->
24 <!-- property values you must customize for successful building!!! -->
25 <property file="build.properties"/>
26 <property file="../build.properties"/>
27 <property file="../../build.properties"/>
28 <property file="${user.home}/build.properties"/>
30 <property name="build.compiler" value="modern"/>
31 <property name="build.dir" value="../build"/>
32 <property name="dist.dir" value="../dist"/>
33 <property name="dist.name" value="docs"/>
36 <!-- =================== BUILD: Create Directories ====================== -->
37 <target name="build-prepare">
38 <mkdir dir="${build.dir}"/>
39 <mkdir dir="${build.dir}/${dist.name}"/>
43 <!-- ================ BUILD: Copy Static Files ========================== -->
44 <target name="build-static" depends="build-prepare">
46 <!-- Top Level Static Files -->
47 <copy todir="${build.dir}/${dist.name}">
49 <include name="BUILDING.txt"/>
50 <include name="README.txt"/>
51 <include name="RUNNING.txt"/>
52 <include name="style.css"/>
55 <copy todir="${build.dir}/${dist.name}">
56 <fileset dir="." includes="**/*.html"/>
59 <!-- Images Subdirectory -->
60 <mkdir dir="${build.dir}/${dist.name}/images"/>
61 <copy todir="${build.dir}/${dist.name}/images">
62 <fileset dir="images"/>
65 <mkdir dir="${build.dir}/${dist.name}/printer"/>
66 <!-- Top Level Static Files -->
67 <copy todir="${build.dir}/${dist.name}/printer">
69 <include name="BUILDING.txt"/>
70 <include name="README.txt"/>
71 <include name="RUNNING.txt"/>
75 destdir="${build.dir}/${dist.name}/printer"
78 excludes="build.xml project.xml empty.xml"
80 <param name="relative-path" expression="./.."/>
81 <param name="project-menu" expression="nomenu"/>
84 <!-- Reference Guide -->
85 <style basedir="reference"
86 destdir="${build.dir}/${dist.name}/reference"
89 excludes="project.xml"
91 <param name="relative-path" expression=".."/>
93 <mkdir dir="${build.dir}/${dist.name}/reference/printer"/>
94 <style basedir="reference"
95 destdir="${build.dir}/${dist.name}/reference/printer"
98 excludes="project.xml"
100 <param name="relative-path" expression="../.."/>
101 <param name="project-menu" expression="nomenu"/>
104 <!-- Generic Howto -->
105 <style basedir="generic_howto"
106 destdir="${build.dir}/${dist.name}/generic_howto"
109 excludes="project.xml"
111 <param name="relative-path" expression=".."/>
113 <mkdir dir="${build.dir}/${dist.name}/generic_howto/printer"/>
114 <style basedir="generic_howto"
115 destdir="${build.dir}/${dist.name}/generic_howto/printer"
118 excludes="project.xml"
120 <param name="relative-path" expression="../.."/>
121 <param name="project-menu" expression="nomenu"/>
124 <!-- Webserver Howto -->
125 <style basedir="webserver_howto"
126 destdir="${build.dir}/${dist.name}/webserver_howto"
129 excludes="project.xml"
131 <param name="relative-path" expression=".."/>
133 <mkdir dir="${build.dir}/${dist.name}/webserver_howto/printer"/>
134 <style basedir="webserver_howto"
135 destdir="${build.dir}/${dist.name}/webserver_howto/printer"
138 excludes="project.xml"
140 <param name="relative-path" expression="../.."/>
141 <param name="project-menu" expression="nomenu"/>
144 <!-- AJP Protocol Reference -->
146 destdir="${build.dir}/${dist.name}/ajp"
149 excludes="project.xml"
151 <param name="relative-path" expression=".."/>
153 <mkdir dir="${build.dir}/${dist.name}/ajp/printer"/>
155 destdir="${build.dir}/${dist.name}/ajp/printer"
158 excludes="project.xml"
160 <param name="relative-path" expression="../.."/>
161 <param name="project-menu" expression="nomenu"/>
164 <!-- Miscellaneous Documentation -->
165 <style basedir="miscellaneous"
166 destdir="${build.dir}/${dist.name}/miscellaneous"
169 excludes="project.xml"
171 <param name="relative-path" expression=".."/>
173 <mkdir dir="${build.dir}/${dist.name}/miscellaneous/printer"/>
174 <style basedir="miscellaneous"
175 destdir="${build.dir}/${dist.name}/miscellaneous/printer"
178 excludes="project.xml"
180 <param name="relative-path" expression="../.."/>
181 <param name="project-menu" expression="nomenu"/>
185 <style basedir="news"
186 destdir="${build.dir}/${dist.name}/news"
189 excludes="project.xml"
191 <param name="relative-path" expression=".."/>
193 <mkdir dir="${build.dir}/${dist.name}/news/printer"/>
194 <style basedir="news"
195 destdir="${build.dir}/${dist.name}/news/printer"
198 excludes="project.xml"
200 <param name="relative-path" expression="../.."/>
201 <param name="project-menu" expression="nomenu"/>
207 <!-- ================= BUILD: XML-HTML Generation ======================= -->
208 <target name="build-main" depends="build-static">
210 <!-- Top Level Directory -->
212 destdir="${build.dir}/${dist.name}"
215 excludes="build.xml project.xml empty.xml"
217 <param name="relative-path" expression="."/>
223 <!-- ==================== BUILD: Rebuild Everything ===================== -->
224 <target name="all" depends="build-clean,build-main"
225 description="Clean and build documentation"/>
228 <!-- ======================= BUILD: Clean Directory ===================== -->
229 <target name="build-clean">
230 <delete dir="${build.dir}/${dist.name}"/>
234 <!-- ======================= DIST: Create Directories =================== -->
235 <target name="dist-prepare">
236 <mkdir dir="${dist.dir}"/>
240 <!-- ======================= DIST: Create Distribution Files ============ -->
241 <target name="dist" depends="build-main,dist-prepare"
242 description="Create documentation binary distribution">
243 <jar jarfile="${dist.dir}/${dist.name}.war"
244 basedir="${build.dir}/${dist.name}" includes="**"/>
248 <!-- ======================= DIST: Clean Directory ====================== -->
249 <target name="dist-clean">
250 <delete dir="${dist.dir}/${dist.name}"/>
254 <!-- ====================== Convenient Synonyms ========================= -->
255 <target name="clean" depends="build-clean,dist-clean"
256 description="Clean build and dist directories"/>