Difference between revisions of "chm backend for fpdoc"
(New page: === Examples === Hi from this link this is all the information about the TOC and Index files in chms: http://www.nongnu.org/chmspec/latest/Sitemap.html These formats are based on HTML a...) |
|||
| Line 1: | Line 1: | ||
=== Examples === | === Examples === | ||
| − | Hi from this link this is all the information about the TOC and Index | + | Hi from this link this is all the information about the TOC and Index files in chms: http://www.nongnu.org/chmspec/latest/Sitemap.html |
| − | files in chms: http://www.nongnu.org/chmspec/latest/Sitemap.html | ||
| Line 8: | Line 7: | ||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> | <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> | ||
| − | The <HEAD> tag contains a <meta> tag providing information on the | + | The <HEAD> tag contains a <meta> tag providing information on the program that generated the files and a comment indicating the version of the file. e.g.: |
| − | program that generated the files and a comment indicating the version of | ||
| − | the file. e.g.: | ||
<meta name="GENERATOR"content="Microsoft® HTML Help Workshop 4.1"> | <meta name="GENERATOR"content="Microsoft® HTML Help Workshop 4.1"> | ||
<!-- Sitemap 1.0 --> | <!-- Sitemap 1.0 --> | ||
| − | The <BODY> tag contains an <OBJECT> tag that stores properties of the | + | The <BODY> tag contains an <OBJECT> tag that stores properties of the file in <param> tags, followed by a UL> tag, whose <nowiki><LI></nowiki> tags have <OBJECT> tags that store the properties of the Contents/Index items in <param> tags. e.g.: |
| − | file in <param> tags, followed by a | ||
| − | <OBJECT> tags that store the properties of the Contents/Index items in | ||
| − | <param> tags. e.g.: | ||
<pre> | <pre> | ||
<BODY> | <BODY> | ||
<OBJECT type="text/site properties"> | <OBJECT type="text/site properties"> | ||
<param name="Property Name" value="Property Value"> | <param name="Property Name" value="Property Value"> | ||
| − | + | … | |
</OBJECT> | </OBJECT> | ||
<UL> | <UL> | ||
| Line 30: | Line 24: | ||
… | … | ||
</OBJECT> | </OBJECT> | ||
| − | + | … | |
</UL> | </UL> | ||
</BODY> | </BODY> | ||
</pre> | </pre> | ||
| − | Note that the Property Names and Property Values and tags are not | + | Note that the Property Names and Property Values and tags are not case-sensitive, but HHW will always write all three in the default capitilization, when appropriate. |
| − | case-sensitive, but HHW will always write all three in the default | ||
| − | capitilization, when appropriate. | ||
| − | Note that the tags are mostly in uppercase and the <LI> tag is not | + | Note that the tags are mostly in uppercase and the <nowiki><LI></nowiki> tag is not closed; this is in compliance with the doctype. |
| − | closed; this is in compliance with the doctype. | ||
| − | Some properties that were seen in HHA.dll that may or may not be used | + | Some properties that were seen in HHA.dll that may or may not be used are Background Image, NumberImages, InformationTypeDecl, Secondary, Icon, Display, Keyword, Instruction, Section Title, Favorites, QueryType, SendEvent, SendMessage, HHI, Inclusive & Exclusive.\ |
| − | are Background Image, NumberImages, InformationTypeDecl, Secondary, | ||
| − | Icon, Display, Keyword, Instruction, Section Title, Favorites, | ||
| − | QueryType, SendEvent, SendMessage, HHI, Inclusive & Exclusive.\ | ||
| − | This the beginning chunk of an autogenerated (the autogenerated TOC | + | This the beginning chunk of an autogenerated (the autogenerated TOC stinks) hhc(TOC) file for the rtl: |
| − | stinks) hhc(TOC) file for the rtl: | + | .hhk are in the same format but are for the Index pane and do not have subitems. |
| − | .hhk are in the same format but are for the Index pane and do not have | ||
| − | subitems. | ||
<pre> | <pre> | ||
DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> | DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"> | ||
Revision as of 16:11, 19 June 2007
Examples
Hi from this link this is all the information about the TOC and Index files in chms: http://www.nongnu.org/chmspec/latest/Sitemap.html
These formats are based on HTML and use the following doctype:
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
The <HEAD> tag contains a <meta> tag providing information on the program that generated the files and a comment indicating the version of the file. e.g.:
<meta name="GENERATOR"content="Microsoft® HTML Help Workshop 4.1">
The <BODY> tag contains an <OBJECT> tag that stores properties of the file in <param> tags, followed by a UL> tag, whose <LI> tags have <OBJECT> tags that store the properties of the Contents/Index items in <param> tags. e.g.:
<BODY>
<OBJECT type="text/site properties">
<param name="Property Name" value="Property Value">
…
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Property Name" value="Property Value">
…
</OBJECT>
…
</UL>
</BODY>
Note that the Property Names and Property Values and tags are not case-sensitive, but HHW will always write all three in the default capitilization, when appropriate.
Note that the tags are mostly in uppercase and the <LI> tag is not closed; this is in compliance with the doctype.
Some properties that were seen in HHA.dll that may or may not be used are Background Image, NumberImages, InformationTypeDecl, Secondary, Icon, Display, Keyword, Instruction, Section Title, Favorites, QueryType, SendEvent, SendMessage, HHI, Inclusive & Exclusive.\
This the beginning chunk of an autogenerated (the autogenerated TOC stinks) hhc(TOC) file for the rtl: .hhk are in the same format but are for the Index pane and do not have subitems.
DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<HTML>
<HEAD>
<meta name="GENERATOR" content="Microsoft® HTML Help Workshop 4.1">
<!-- Sitemap 1.0 -->
</HEAD><BODY>
<OBJECT type="text/site properties">
<param name="Auto Generated" value="Yes">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Reference for package 'rtl'">
<param name="Local" value="rtl/index.html">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Units">
<param name="Local" value="rtl/index.html">
</OBJECT>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Description">
<param name="Local" value="rtl/index.html">
</OBJECT>
</UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Reference for unit 'BaseUnix'">
<param name="Local" value="rtl/baseunix/index.html">
</OBJECT>
<UL>
<LI> <OBJECT type="text/sitemap">
<param name="Name" value="Overview">
<param name="Local" value="rtl/baseunix/index.html">
</OBJECT>
</UL>
......
</UL>
