granicus.if.org Git - apache/blob - docs/manual/style/description.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2
   3 <!--
   4  Licensed to the Apache Software Foundation (ASF) under one or more
   5  contributor license agreements.  See the NOTICE file distributed with
   6  this work for additional information regarding copyright ownership.
   7  The ASF licenses this file to You under the Apache License, Version 2.0
   8  (the "License"); you may not use this file except in compliance with
   9  the License.  You may obtain a copy of the License at
  10
  11      http://www.apache.org/licenses/LICENSE-2.0
  12
  13  Unless required by applicable law or agreed to in writing, software
  14  distributed under the License is distributed on an "AS IS" BASIS,
  15  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  See the License for the specific language governing permissions and
  17  limitations under the License.
  18 -->
  19
  20 <description>
  21 This build file contains all operations that are necessary for building
  22 the Apache httpd documentation. It is called by invoking build.bat (Win32)
  23 or build.sh (/bin/sh systems) with a target argument (full list below).
  24 For example, if you want to build the Japanese HTML files, type:
  25
  26   ./build.sh ja
  27
  28 Some targets have additional requirements:
  29
  30 * 'metafiles' and 'modulelists' need perl in PATH. (It's checked automatically
  31   and skipped if perl is not available)
  32
  33 * 'chm-foo' targets need:
  34   - the HTML Help compiler in PATH (or modify this build file). The
  35     compiler (hhc.exe) is part of the HTML Help Workshop which is freely
  36     available and can be downloaded from
  37     http://msdn.microsoft.com/en-us/library/windows/desktop/ms669985%28v=vs.85%29.aspx
  38   - The appropriate locale (e.g. Japanese) before invoking hhc.exe. Otherwise
  39     the compiler is not able to build the fulltext search index correctly and
  40     the TOC may be garbled, too. In particular:
  41     + chm-da: Dansk (DK)
  42     + chm-de: German (Germany), sorting order: dictionary
  43     + chm-en: English (USA)
  44     + chm-es: Spanish (Spain), sorting order: international
  45     + chm-ja: Japanese
  46     + chm-ko: Korean
  47     + chm-tr: Turkish
  48     + chm-zh-cn: Simplified Chinese
  49
  50 </description>