DISTRIBUTION OF A WEB SITE DEVELOPMENT BASE
===========================================
Author : Dominique Guebey


GENERAL
=======
Goal : making available the author's website generation method : http://www.dg77.net

This set include xslt transformations applied to standardized XML files. A default file style and sample pages are provided.

Proper functioning requires the presence of Java on your system. 
The Saxon9 processor is provided. This allows portability on a maximum of operating systems. It is nevertheless advisable to perform local testing on a case sensitive (upper / lower case distinction) machine such as Linux or UNIX / BSD. This prevents errors in the names of files and directories once posted on a remote server.

This set does not support the on-line uploading and implementation, their backup or versioning. These tasks are left to the responsibility of each one.

Technical documentation in French can be found at the following URL : http://www.dg77.net/tekno/sitedoc.htm
The distribution can be downloaded here (some additional informations are displayed): http://www.dg77.net/tekno/sitedoc.htm#distrib

IMPLEMENTATION
==============
The minimum implantation description.
Main directories :
  - bin : programs and scripts
  - design : common elements
      - style sheets
      - parameters files and configuration
      - headers and menus
  - XML/XSL : XSLT transformation 
  - XML/SRC : html pages content
  - Other directories, depending of the designer

Detailed composition :
----------------------
- bin/
  - "batch" (.bat) générator program
  - Java program used when generating (Saxon9).

- design/ : 
  Config.xml and root_index must always exist under that name and in this location.
  - Config.xml indicating the names and locations (domain name, style sheets, the header banner,)
  - root_index.xml file, indicating the wording of the header and the header file with links, depending on the directory or subdirectory. root_index contains a "mapping" of the site.
  - default style sheets (can be changed in Config.xml).
  - default banner (root_bando.xml)
  - the header, with default links (menu_root.xml)

- design/images/
  - Icons and images used by the site.

- XML/XSL/ : contains the XSLT transform modules, in particular:
  - x8_o_utf8 : launcher (calls dg8_3.xsl)
  - dg8_3.xsl : load variables, includes all xsl files.
    * receives external parameters :
      - timestamp,
      - name of the input XML source file
      - name of the html output page (if this parameter is absent or blank or "x": by default all pages of the xml file are created)
    * loads variables from design/Config.xml
    * loads ("include" operation) the whole set of xsl files
  - dg8_h.xsl : main processing module
  - listent.ent : entities file, called by xml file [note 1]
      sample : <!DOCTYPE www SYSTEM "../XSL/listent.ent">

- XML/XSL_spec/ : adds specific xsl modules, ensure not to modify its contents when updating the distrib.

- XML/SRC/ :
    - xml "sources" files, each of which can contain multiple html pages data.
    - sample files templatexxx.xml that provide usable pages examples

- Other: directories and subdirectories of examples pages and their accessories (pictures).


INSTALLATION METHOD
===================
a) extracting
Extract the "zip" file contents. It contains a www_template directory. Copy the folder to a location on your own, designed for your specific needs (e.g. www_perso). If you later retrieve a newer version of the distribution, it will avoid the risk of inadvertent crushing of data.

b) préparation
  - Adapt design/Config.xml
  - Adapt design/root_index.xml according to the tree (directories) proposed.
  - Adapt banner
  - Adapt header menu, possibly create new ones (specified in index.xml root).

HTML PAGES MANAGEMENT
=====================
  - Create a source file from sample.xml
  - Create a new page by inserting (see examples)

<page nomfic="demo/%%%%%%.htm" retour="index.html" e="">
<description>
    <cre>ssaa-mm-jj</cre>
    <upd></upd>
    <titre>xxxxxxxxxxxxxxxxxxxxx</titre>
    <description></description>
    <keywords></keywords>
	<style css=""></style>
        <docu></docu>
        <lang></lang>
</description>
            ...
            HTML TAGS / BALISAGE HTML
            ...
</page>

Mandatory tags and attributes
- page
- page/@nomfic
- page/titre/




NOTES
=====
[note 1] Using entities (e.g.: &eacute; instead of "é" character). The advantage is that the source file only contains ASCII characters. he advantage is that there will be no problem if one day we decide to change encoding : accented characters and other symbols are converted according to the specified encoding.