null,
'content' => '
Software documentation systems
Presentation for Hypermedia systems
Ondrej Holotnak <beast@pobox.sk>
Ondrej Jombik <nepto@pobox.sk>
19th December 2002
');
$data[1] = array(
'title' => 'Introduction',
'content' => array(
'documentation is important',
array('target group', array(
'user-oriented systems',
'developer-oriented systems',
'other systems')),
'different approaches'
));
$data[2] = array(
'title' => 'DocBook intro',
'content' => array(
'structured documents using SGML or XML',
'DocBook is SGML DTD',
'open tool',
'standard vs. own tools'
));
$data[3] = array(
'title' => 'Writing in DocBook',
'content' => array(
'logical structure',
'marked by meaning',
'no design tags',
'design controlled by DSSSL'
));
$data[4] = array(
'title' => 'DocBook versions',
'content' => array(
'SGML vs. XML',
'minimal differences',
'different processing'
));
$data[5] = array(
'title' => 'DocBook document',
'content' => array(
'basic document using
<!DOCTYPE ...>, <book>, <bookinfo> (example)',
'document structure using
<chapter>, <sect1>, <sect2> (example)'
));
$data[6] = array(
'title' => 'DocBook logical structure',
'content' => array(
'marked by meaning',
'tagging filenames, variables, products using
<filename>, <varname>, <productname> (example)',
'special end tag </>'
));
$data[7] = array(
'title' => 'DocBook processing',
'content' => array(
'lot of output formats:
HTML, RTF, PDF, PS, TeX, TXT, man',
'prepared shell scripts:
$ db2html myfile.sgml'
));
$data[8] = array(
'title' => 'Developer-oriented documentation systems (DODS)',
'content' => array(
array('tools according to programming language', array(
'Doxygen (C/C++)',
'PearDoc (PHP/PEAR)',
'JavaDoc (Java)'))
));
$data[9] = array(
'title' => 'Commenting sources using DODS',
'content' => array(
'documentation included in source codes',
'all entities documented',
'special marks usage'
));
$data[10] = array(
'title' => 'Advantages of DODS',
'content' => array(
'complexity',
'all in one place',
'automatic info extraction',
'timesaving'
));
$data[11] = array(
'title' => 'Documented class using DODS',
'content' => array(
array('class Example documented in', array(
'Doxygen (example)',
'PearDoc (example)',
'JavaDoc (example)'))
));
$data[12] = array(
'title' => 'DODS marks',
'content' => array(
'comments starting /'.'**',
'universal marks: @author, @version, @date, @since, @deprecated, @see, @todo (example)',
'function marks: @param, @return, @retval, @access'
));
$data[13] = array(
'title' => 'DODS processing',
'content' => array(
'a lot of formats (depends on system)',
'Doxygen: HTML, LaTeX, RTF, XML, man',
'configuration in Doxyfile',
'generation:
$ doxygen'
));
$data[14] = array(
'title' => 'Other documentation systems',
'content' => array(
'PerlDoc',
'man',
'info'
));
?>