6.1 Files and Directories

This is a brief diagram of www working copy; note that in this section we don’t describe the files out of GNUN control, including the old HTML-only translations.

Legend:
*   The file is maintained locally, without committing it to CVS.
#   The file is edited manually.
@   The file is regenerated automatically.
%   The file is edited both manually and automatically.
#/@ The file is generated automatically, but outside of GNUN.

Root/
  |
  +--proprietary/
  |   |
  |   +--proprietary.html #
  |   +--proprietary.lang.html @
  |   +--malware-cars.html #
  |   +--malware-cars.lang.html @
  |   +--…
  |   |
  |   +--------------------------po/
  |                               |
  +--home.html #                  +--malware-cars.lang.po %
  +--home.lang.html @             +--malware-cars.pot @
  +--planetfeeds.html #/@         +--malware-cars.proto * @
  +--planetfeeds.lang.html @      +--malware-cars.translist @
  +--po/                          |
  |  |                            +--malware-cars.lang-en.html @
  |  +--home.pot @                +--malware-cars.lang-diff.html @
  |  +--home.proto * @            +--proprietary.lang.po %
  |  +--home.translist @          +--pot @
  |  +--home.lang.po %            +--lang.po %
  |  +--home.lang-en.html @       +--…
  |  +--home.lang-diff.html @
  |  +--planetfeeds.proto * @
  |  +--planetfeeds.pot.opt @
  |  +--planetfeeds.lang.po %
  |  +--…
  |
  +--server/
  |  |
  |  +-------------------------gnun/
  |  |                           |
  |  +--sitemap.html #/@         +--GNUmakefile * #
  |  +--sitemap.lang.html @      +--config.mk * #
  |  +--po/                      +--gnun.mk #
  |  |  |                        +--priorities.mk #
  |  |  +--sitemap.pot @         +--languages.txt #
  |  |  +--sitemap.proto * @     +--compendia/
  |  |  +--sitemap.lang.po %          |
  |  |  |                             +--master.lang.po #
  |  |  +--body-include-2.pot @       +--compendium.lang.po @
  |  |  +--body-include-2.proto * @   +--compendium.pot @
  |  |  +--body-include-2.lang.po %   +--excluded.pot #
  |  |  +--…
  |  |  
  |  +--body-include-2.html #
  |  +--body-include-2.lang.html @
  |  +--…
  +--…

A description of some files follows.

…/file.html

The English files.

…/file.lang.html

The lang translation of …/file.html.

…/po/file.proto

Intermediate files generated from file.html; they are used only internally. Essentially, GNUN inserts its special slots. See Special GNUN messages, for more details.

…/po/file.translist

The list of translations for …/file.html. It is included in …/file.html and all its translations.

…/po/file.pot

PO templates for articles and included files.

…/po/file.pot.opt

POTs of optional templates. See optional-templates, for more details.

…/po/file.lang.po

Translations of file.pot or file.pot.opt committed by the translators and merged by GNUN.

…/po/file.lang-en.html

The latest revision of the English file for which a full translation into lang language was provided.

…/po/file.lang-diff.html

The highlighted differences between the current version of …file.html and …/po/file.lang-en.html.

…/po/pot

Per-directory template. It contains all strings from all articles in this directory. See Per-Directory Templates.

…/po/lang.po

Per-directory compendium. It is only used and regenerated when …/po/pot exists. See Per-Directory Templates.

planetfeeds.html

A list of news; it is automatically generated outside of GNUN. For GNUN, it is an optional template.

server/

Most template SSI files are located in this directory.

server/sitemap.html

The sitemap; it is generated automatically by a script that is not included in GNUN. See Building Sitemap.

server/gnun/

The directory for GNUN files.

server/gnun/GNUmakefile

server/gnun/config.mk

These files are maintained locally. They are used to rebuild the translations. See Invoking GNUN.

server/gnun/gnun.mk

The file that defines the list of files to build. See Defining Articles to Be Built.

server/gnun/priorities.mk

This file defines the list of translation priorities. See priorities.mk.

server/gnun/languages.txt

Canonical names for languages. See The languages.txt File.

server/gnun/compendia

The directory for compendia. See Using Compendia.