Admin/website/README
changeset 16952 9ce755a0d613
parent 16572 81778a796290
child 17681 442e7bec1d49
equal deleted inserted replaced
16951:6d21767178e6 16952:9ce755a0d613
     2 ====================
     2 ====================
     3 
     3 
     4 (1) philosophy
     4 (1) philosophy
     5 ==============
     5 ==============
     6 
     6 
     7 The webpage sources consists of three different layers:
     7 The webpage sources consist of three different layers:
     8 
     8 
     9 a) the presentation layer
     9 a) the presentation layer
    10 -------------------------
    10 -------------------------
    11 
    11 
    12 This is was the user actually sees; the slogan is
    12 This is was the user actually sees; the slogan is
    35 file.
    35 file.
    36 
    36 
    37 c) the preprocessing layer
    37 c) the preprocessing layer
    38 --------------------------
    38 --------------------------
    39 
    39 
    40 This allows to use things like includes, current date and so on:
    40 This allows to use things like includes, current date, and so on:
    41 
    41 
    42     "XHTML plus processing instructions"
    42     "XHTML plus processing instructions"
    43 
    43 
    44 Note that this is almost not interwoven with b), to keep it as robust
    44 Note that this is almost not interwoven with b), to keep it as robust
    45 and simple as possible.
    45 and simple as possible.
    51 ==========================
    51 ==========================
    52 
    52 
    53 You may add arbitrary files to the dir structure, but adhere to the following:
    53 You may add arbitrary files to the dir structure, but adhere to the following:
    54 * use XHTML, not loose HTML
    54 * use XHTML, not loose HTML
    55 * only structural markup; if you need layout effects, use CSS
    55 * only structural markup; if you need layout effects, use CSS
    56   (browse the exitings files to get some inspirations)
    56   (browse the exiting files to get some inspirations)
    57 * any files ending with .html are considered as HTML files and are implicitly
    57 * any files ending with .html are considered as HTML files and are implicitly
    58   processed by the preprocessing layer
    58   processed by the preprocessing layer
    59 * for HTML includes, it is most convenient to name them *.include.html to
    59 * for HTML includes, it is most convenient to name them *.include.html to
    60   avoid them to be processed stand-alone by the preprocessing layer
    60   avoid them to be processed stand-alone by the preprocessing layer
    61 * whole dirs maybe selected for statically copying them to the
    61 * whole dirs maybe selected for statically copying them to the
    65   but expressed relatively to the current location, e. g.
    65   but expressed relatively to the current location, e. g.
    66 
    66 
    67   in abc/def/itsme.html: <a href="//abc/ghi/itsyou.html">
    67   in abc/def/itsme.html: <a href="//abc/ghi/itsyou.html">
    68                 becomes: <a href="../def/itsyou.html">
    68                 becomes: <a href="../def/itsyou.html">
    69 
    69 
    70   Further, targets are checked for existances.
    70   Further, targets are checked for existance.
    71   This is a simple yet powerful thing easing to keep the pages consistent.
    71   This is a simple yet powerful thing easing to keep the pages consistent.
    72 * for the semantics of the processing instructions, see build/pypager.py
    72 * for the semantics of the processing instructions, see build/pypager.py
    73   source code
    73   source code
    74 
    74 
    75 
    75 
    81 
    81 
    82 Then, you may edit the project configuration file conf/localconf.mak.
    82 Then, you may edit the project configuration file conf/localconf.mak.
    83 After a correct configuration, the build process may be started by
    83 After a correct configuration, the build process may be started by
    84 > make
    84 > make
    85 
    85 
    86 The project layer tries to be smart about dependencies, but inlucdes,
    86 The project layer tries to be smart about dependencies, but includes,
    87 embedded images and so on are not tracked; to built dependencies anew,
    87 embedded images and so on are not tracked; to built dependencies anew,
    88 do
    88 do
    89 > make depends
    89 > make depends
    90 
    90 
    91 After adding or deleting files, an
    91 After adding or deleting files, an