The original User_doc.html is maintained by msword as
a web site.
A copy for UNIX like systems is done saving User_doc
as text and converting it into POD format using this script.
Thus, this script performs the following tasks:
- eliminate unused text:
s/^Content\s*$//
s/^\s*See screenshot\s*$//
- add =head(1,2,3) to title lines:
s/^(\d\)s+(.+)$/=head1 $1/ if list == on then "\n=back\n"; if list2 == on then "\n=back\n"
- generate list (=over, =items, =end):
s/^\*/=item/ if list = off then "\n=over\n"
s/^o/=item/ if list2 =off then "\n=over\n"
- split lines longer than 80 chars
- indent all other lines:
$line = " $line"
The output is written to user_doc.pod
perl ctkAdaptUser_doc.pl <input>
where <input> is the file name of the input file.
Default file name is ./doc/userDoc/user_doc_0.txt'.
- TODO (18.03.2008)
-
- launch perldoc to generate flat file user_doc_new.txt
- replace <crlf> with \n s/\r$// in user_doc.txt
