1 |
Documentation manipulation scripts for Clonezilla-SysRescCD |
2 |
------------------------------------------------------------------------------ |
3 |
|
4 |
The scripts contained in this directory are used to update / create the |
5 |
documentation of Clonezilla-SysRescCD. The docs are actually written / updated |
6 |
within the working/ directory and then the scripts put them together in the |
7 |
www/ directory. A simplified version of the html docs is created in the 2doc/ |
8 |
directory, for off-line browsing. At the same time a text only version of this |
9 |
documentation is created in the same directory. |
10 |
|
11 |
These scripts are: |
12 |
|
13 |
a. update-boot-params |
14 |
Updates documentation embedded in page boot-params.html. This page contains |
15 |
as-is content coming from the original project pages (Clonezilla and |
16 |
SystemRescueCD) |
17 |
|
18 |
b. 2site |
19 |
This script creates the actual online html documentation pages. It also creates |
20 |
the off-line docs, using scripts html2txt and html2offline |
21 |
|
22 |
It takes each html (and php) page from the working/ directory and modifies it |
23 |
using some tamplate files, and then creates the TOC file (doc.html) |
24 |
|
25 |
If you want to change the header, footer and appearence of the pages, you |
26 |
should edit the template files: .404.html, .news.php and .template.html, |
27 |
located in the working/ directory. |
28 |
|
29 |
c. html2doc |
30 |
This script copies some of the html pages found in www/ directory to |
31 |
www/2doc/doc/ directory, and then moves doc/doc.html to the parent directory |
32 |
and renames it to README.html |
33 |
|
34 |
d. html2txt |
35 |
Creates a file called README.txt in directory 2doc/, containing a text-only |
36 |
version of the project's docs. This file contains a limited number of the |
37 |
original (on-line) pages. |
38 |
|