1 |
jpaalasm |
607 |
The Skencil Website |
2 |
|
|
=================== |
3 |
|
|
|
4 |
|
|
Overview |
5 |
|
|
-------- |
6 |
|
|
|
7 |
|
|
The Skencil website consists of a bunch of static html files that are generated |
8 |
|
|
from a page layout file and files that contain the bodies of every page. |
9 |
|
|
|
10 |
|
|
FAQ and Release Notes sections of the website are generated by scripts that are |
11 |
|
|
in folders faq/ and relnotes/, respectively. The rest of the pages are just |
12 |
|
|
plain html files in folder pages/. |
13 |
|
|
|
14 |
|
|
|
15 |
|
|
Required Software |
16 |
|
|
----------------- |
17 |
|
|
|
18 |
|
|
Roughly these software packages are required to build the html files of the |
19 |
|
|
Skencil website. |
20 |
|
|
|
21 |
jpaalasm |
608 |
- Python version 2.2 or above is required. |
22 |
jpaalasm |
607 |
|
23 |
|
|
- Docutils (http://docutils.sf.net) (for Release Notes) |
24 |
|
|
|
25 |
|
|
- Python XML (http://pyxml.sf.net) (for the FAQ) |
26 |
|
|
|
27 |
|
|
- The following are needed if you want to build the gallery files: |
28 |
|
|
|
29 |
|
|
* Skencil 0.6.13. More precisely, any Skencil version that contains |
30 |
|
|
sk2ppm which was first shipped with 0.6.13 |
31 |
|
|
|
32 |
|
|
* cjpeg. In Debian woody package: libjpeg-progs |
33 |
|
|
|
34 |
|
|
* pnmscale. In Debian woody package: netpbm |
35 |
|
|
|
36 |
|
|
* Fonts to generate the Gallery images in the Skencil's font_path. |
37 |
|
|
|
38 |
|
|
(If you get warning messages like: |
39 |
|
|
I cannot find the metrics for the font URWChanceryL-MediItal. |
40 |
|
|
The file z003034l.afm is not in the font_path. |
41 |
|
|
I'll use the metrics for Times-Roman instead. |
42 |
|
|
you can ignore this or add a path to font_path which has "z003034l.afm".) |
43 |
|
|
|
44 |
|
|
|
45 |
|
|
Required accounts |
46 |
|
|
----------------- |
47 |
|
|
|
48 |
|
|
The sources of the website are kept in folder skencil.org/ in Skencil's |
49 |
|
|
"Software" CVS repository on Savannah. To make changes to them you either have |
50 |
|
|
to send us patches or get commit permission from us which requires a |
51 |
|
|
Savannah account and becoming a member of the Skencil project at Savannah |
52 |
|
|
(http://savannah.nongnu.org/projects/skencil/). |
53 |
|
|
|
54 |
|
|
The actual hosted html files are in Skencil's "Web Pages" CVS repository. |
55 |
|
|
|
56 |
|
|
|
57 |
|
|
Building the Website |
58 |
|
|
-------------------- |
59 |
|
|
|
60 |
bernhard |
624 |
Run "./updatepages.py" to update the web-pages in folder skencil/. |
61 |
|
|
(Use "--force" to create all of them regarding of the creation times.) |
62 |
jpaalasm |
607 |
If you also want to update Release Notes or the FAQ, you have to run the |
63 |
|
|
updatefaq and updaterelnotes.py scripts in folders faq/ and relnotes/ |
64 |
|
|
before you run updatepages.py. |
65 |
|
|
|
66 |
|
|
Gallery images can be built by running "make" in folder gallery/. Note |
67 |
|
|
that the gallery images require a lot of space for intermediate files; |
68 |
|
|
currently aroung 60MB. |
69 |
|
|
|
70 |
|
|
To upload the final html files to Savannah, just commit them to Skencil's |
71 |
|
|
"Web Pages" CVS repository. That can be achieved easily if "Web Pages" is |
72 |
|
|
checked out as skencil/ folder. |