1 Introduction
mytexi - Derivative of texinfo software documentation system. Reformed texinfo syntax for easy of use. It is primarily designed for creating online manuals.
-
know-how/mytexi - Software
mytexi - Derivative of texinfo software documentation system. Reformed texinfo syntax for easy of use. It is primarily designed for creating online manuals
/know-how/mytexi/
1.1 Why another texinfo implementation?
CONSTRUCTION
[ Construction - Please Wait ]
1.2 mytexi vs. texinfo
CONSTRUCTION
[ Construction - Please Wait ]
A texinfo Sample:
[ helloworld2.texi ]
2 Usage
mytexi <path_to_mytexi_source_document>
% ./mytexi.pl helloworld.mtxi
title: My title of this document
author: Reto Hersiczky
date: 08.09.2004
=======> Includes printer-friendly pages (hellomytexi/print/)
============> TITLE PAGE - hellomytexi/index.html <============
=======> [1] - hellomytexi/animals.html
=======> [1.1] - hellomytexi/animals_on_earth.html
=======> [1.2] - hellomytexi/animals_under_water.html
=======> [2] - hellomytexi/vehicles.html
=======> [2.1] - hellomytexi/cars_sub.html
=======> [2.1.1] - hellomytexi/cars_sub_sub.html
=======> [2.1.1.1] - hellomytexi/cars_sub_sub_sub.html
=======> [2.2] - hellomytexi/cars_sub_2.html
=======> [2.3] - hellomytexi/motor_bikes.html
=======> 9 pages have been genereated with 0 errors
3 Reference
The content part is separated from the mytexi header with at least two newlines.
@comment >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> mytexi header
title : My title of this document
author : Reto Schär
date : @DATE{NOW,DD.MM.YYYY}
foobar : foo
PROJECT : hellomytexi
HTML_SUFFIX : .html
@comment >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> end mytexi header
<content_part_from_here>
3.1 Menus
Menu at the titlepage
$MENU{}
Menu at a chapter page
$SUBMENU{O=VER}
Prevent an entry on the main table of contents
This might me useful if you want to suppress the alphabetical index from
appearing on the table of contents. Another example are very deep sub pages.
@subchapter ref="example" caption="An Example" control="not_on_main_toc=1||foo=bar"
3.2 @-command List
[ Example ]
Main Commands
@comment
Same as texinfo. May appear anywhere in your document.
@comment <any text treated as comment to the end of line>
@header, @footer
Layout, Header, Footer
@header
@footer
@call cmd="shell_command"
The output of the command «shell_command» will be inserted at
this position
Sections: @[sub]*chapter
@chapter
Chapter, Document Structure
@chapter
@subchapter ref="motor_bikes" caption="Motor Bikes"
@subsubchapter ref="cars_sub_sub" caption="European Cars in Detail"
@subsubsubchapter ref="cars_sub_sub_sub" caption="European Cars in Full Detail"
@titlepage
@index
Will be replaced by a reference index. This at-command has to be located at the end of the mytexi
document. You may tag a word to be indexed by just appending <!-- __INDEX -->.
If you want to set another word that appears on the index, use the following syntax: <!-- __INDEX foo bar -->.
See an example.
Special
Current Date
@DATE{NOW,DD.MM.YYYY}
Sections: @header, @footer, @[sub]*chapter, @titlepage
@include <path_to_file>
Same as texinfo. Include and parse files.
Sections: @titlepage, @header, @[sub]*chapter
@include_body <path_to_file>
Same as texinfo. Include and parse files but grabs the body section only.
Sections: @[sub]*chapter
@include_core_body <path_to_file>
Same as @include. Include and parse files but grabs only the section between
<!-- __CORE_BODY --> and <!-- /__CORE_BODY -->
Sections: @header, @footer, @[sub]*chapter
@url{URI}
Same as texinfo.
Sections: @[sub]*chapter, include Files
@suppress_if_printer_friendly
html code
@end suppress_if_printer_friendly
3.3 Examples (Hello, World!)
A «Hello, World» example
Find an example that includes all features like chapters, sub chapters, include files.
[ View mytexi Source ]
[ Browse through the document ]
Tips
Analyze your document structure
grep chapter <your_mytexi_doc.mtxi> | grep @
3.3.1 Start Template
[ Tpl start.mtxi ]
3.4 Special things
You can easily let rename the index a.k.a. title page by adding this directive
withing the mytexi header
HTML_SUFFIX : .html
TITLE_INDEX : index2
4 Download mytexi.pl
This software is Beta.
Some enhancements are in progress. Syntax might be subject to change.
5 Tools - Generate mytexi Source
[ See also: ../helloworld.mtxi ]
See also:
Suggested Structures
6 Links
mytexi Links
7 Bug Report
[ Continue ]
8 Alphabetical Index
C - D - I - M - P - R - S - T - U