description.xml revision b890249d7a508d6c70220e5ed0b48d1e5829cf05
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder<?xml version="1.0" encoding="utf-8"?>
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder<!--
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder Licensed to the Apache Software Foundation (ASF) under one or more
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder contributor license agreements. See the NOTICE file distributed with
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder this work for additional information regarding copyright ownership.
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder The ASF licenses this file to You under the Apache License, Version 2.0
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder (the "License"); you may not use this file except in compliance with
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder the License. You may obtain a copy of the License at
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder http://www.apache.org/licenses/LICENSE-2.0
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder Unless required by applicable law or agreed to in writing, software
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder distributed under the License is distributed on an "AS IS" BASIS,
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder See the License for the specific language governing permissions and
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder limitations under the License.
3ab1e7a18f3fc3eb004464bc54b7df4483f1f060Christian Maeder-->
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder<description>
f799084b320209cdd71a29e74fff1be054c1d342Christian MaederThis build file contains all operations that are necessary for building
f799084b320209cdd71a29e74fff1be054c1d342Christian Maederthe Apache httpd documentation. It is called by invoking build.bat (Win32)
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian Maederor build.sh (/bin/sh systems) with a target argument (full list below).
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian MaederFor example, if you want to build the Japanese HTML files, type:
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian Maeder
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian Maeder /build.sh ja
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian Maeder
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian MaederSome targets have additional requirements:
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian Maeder
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian Maeder* 'metafiles' and 'modulelists' need perl in PATH. (It's checked automatically
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian Maeder and skipped if perl is not available)
03a6bbff551286168d0b15dc53476c2ede4e60d0Christian Maeder
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder* 'chm-foo' targets need:
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder - the HTML Help compiler in PATH (or modify this build file). The
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder compiler (hhc.exe) is part of the HTML Help Workshop which is freely
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder available and can be downloaded from
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder http://msdn.microsoft.com/en-us/library/windows/desktop/ms669985%28v=vs.85%29.aspx
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder - The appropriate locale (e.g. Japanese) before invoking hhc.exe. Otherwise
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder the compiler is not able to build the fulltext search index correctly and
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder the TOC may be garbled, too. In particular:
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder + chm-da: Dansk (DK)
0015e1756b734b34d4b550318c078f9a0c585611Christian Maeder + chm-de: German (Germany), sorting order: dictionary
479da8506f391abe070ced2fb93c9759a280fa68Christian Maeder + chm-en: English (USA)
479da8506f391abe070ced2fb93c9759a280fa68Christian Maeder + chm-es: Spanish (Spain), sorting order: international
0015e1756b734b34d4b550318c078f9a0c585611Christian Maeder + chm-ja: Japanese
f799084b320209cdd71a29e74fff1be054c1d342Christian Maeder + chm-ko: Korean
0015e1756b734b34d4b550318c078f9a0c585611Christian Maeder + chm-tr: Turkish
0015e1756b734b34d4b550318c078f9a0c585611Christian Maeder + chm-zh-cn: Simplified Chinese
0015e1756b734b34d4b550318c078f9a0c585611Christian Maeder
0015e1756b734b34d4b550318c078f9a0c585611Christian Maeder</description>