ADDING A NEW PAGE
Adding a new page is very easy but requires a little bit of knowledge
and discipline.
If you have not done so yet, look at the source of any page on the
site in your web browser. The main page index.htm is a good starting
point. You are looking for the <div id="content"> element. That's
where your new code will go.
Start your new page. You only have to write the HTML that goes inside
the content element.
Upload it, and supporting files/images. Then test to see that the
site puts the template around it properly. If it does not, chances
are that some tags are not properly closed. Check the syntax of your
file.
Once the file displays correctly in the browser, edit /header.php.
At the beginning of header.php is the array $page that describes all
the pages added manually to this site. Add an entry to your page by
looking at one of the existing examples. Note that the list is
ordered.
ADDING A NEW VERSION OF THE DOCUMENTATION
Starting with enblend-enfuse 4.0 and with the 2009-2010 website,
documentation is added to the site almost automatically:
1. Fetch the latest enblend-enfuse source
2. Build documentation
3. Extract it from the XHTML context
4. Upload it to the website
In detail:
1. fetch the latest enblend-enfuse source
Wait for the developers to tag a release, then do the following.
If you don't have the enblend source on your machine, get it now:
$ hg clone http://enblend.hg.sourceforge.net:8000/hgroot/enblend/enblend
Enter the source:
$ cd enblend
Get the latest changes:
$ hg pull
...
Look for the tags:
$ hg tags
tip 639:7a2748a40606
Release-4_0-20091213 637:d394f60f8edf
...
Update to a clean and known status:
$ hg update -C -r 637
...
2. Build documentation
Bootstrap the code and make sure that the line "can build all
documentation:" toward the end of the makefile execution says "yes".
If it says that something is missing, fix it.
$ make --makefile=Makefile.scm
...
$ ./configure
...
can build all documentation: yes
...
Build the documentation.
$ make pdf
...
$ make xhtml
...
3. Extract it from the XHTML context
Enter the documentation folder and rename the folders for the
website. Substitute V.V.V for the tagged version number
$ cd doc/
$ mv enblend.pdf enblend_V.V.V.pdf
$ mv enfuse.pdf enfuse_V.V.V.pdf
$ mv enblend.xhtml enblend_V.V.V.xhtml
$ mv enfuse.xhtml enfuse_V.V.V.xhtml
Extract the content from the XHTML context by using the shell script
located in the website's source code repository at src/apply.sh
4. Upload it to the website
Add the enblend_V.V.V.xhtml and enblend_V.V.V.pdf to the enblend.doc
folder on the website, and do the same with the enfuse documentation
to enfuse.doc
The website's template will integrate the new documentation
automatically.
Yuval Levy / 17-Dec-2009