Re: [Doxygen-users] rtf style and extensions
Brought to you by:
dimitri
Menu
▾
▴
Re: [Doxygen-users] rtf style and extensions
|
From: Randall, L. <l-r...@ti...> - 2006-06-13 23:03:49
|
Hi, Michael, The extensions will not show up in the text. They become file properties, which are accessible in Word. Comment: Doxygen provides good RTF output, but it does NOT build a "real" document. That is up to you. 1.1 Edit RTF n Open the Doxygen generated RTF file in Word. =20 n Edit->Replace ([ALT], e, e) to Replace All "^b" (sections) with nothing. n SAVE the document. n Replace All "^p^p" with "^p". Repeat until 0 replacements. n Save the document. Now, take the "meat" of the document (without cover page, TOC and Index) and paste it into the "real" document. (i.e., One with a Cover page, TOC, Headers, Footers, logo, etc.) RTF STYLESHEET The RTF Style sheet is a "style description and mapping" sheet. This is an excerpt from mine: " Heading1 =3D \s1\ql \fi-720\li720\ri0\sb240\sa60\keepn\widctlpar\jclisttab\tx720\aspalpha\as pnum\faauto\ls156\ilvl1\outlinelevel1\adjustright\rin0\lin720\itap0 \b\f1\fs28\lang1033\langfe1033\kerning32\cgrid\langnp1033\langfenp1033 \snext15 2_Heading Heading2 =3D \s2\ql\fi-1080\li1080\ri0\sb200\sa60\keepn\widctlpar\jclisttab\tx1080\as palpha\aspnum\faauto\ls156\ilvl2\outlinelevel2\adjustright\rin0\lin1080\ itap0 \b\f1\fs24\lang1033\langfe1033\kerning28\cgrid\langnp1033\langfenp1033 \snext15 3_Heading Heading3 =3D \s3\ql \li0\ri0\sb120\keepn\widctlpar\aspalpha\aspnum\faauto\adjustright\rin0\l in0\itap0 \b\f1\fs22\lang1033\langfe1033\kerning22\cgrid\langnp1033\langfenp1033 \sbasedon0 \snext66 mp_Topic" The format is: "Doxygen name" =3D (e.g., Heading1 =3D): This is the "mapped from" -- = the name that Doxygen calls the style. DO NOT change this name. "RTF style description": =20 \s1 =3D style number 1 \ql =3D left justified \fi-720 =3D first line indented 0.5 inch or 720 twips NOTE: Twips are screen-independent units used to ensure that the placement and proportion of screen elements in your screen application are the same on all display systems. A twip is a unit of screen measurement equal to 1/20 of a printer's point. There are approximately 1440 twips to a inch (the length of a screen item measuring one inch when printed). \li720 =3D left indent 0.5 inch or 720 twips \ri0 =3D right indent 0 units \sb240 =3D space before 12 points or 240 twips \sa60 =3D space after 3 points or 60 twips \keepn =3D keep with next \widctlpar =3D Widow/orphan control is used for the current paragraph. This is a paragraph property used to override the absence of the document-level \widowctrl. \jclisttab =3D In addition to all of the (list) properties, each list level can contain any character properties (all of which affect all text for that level) and any combination of three paragraph properties: left indents, first line left indents, and tabs-each of which must be of a special type: jclisttab. These paragraph properties will be automatically applied to any paragraph in the list. \tx720 =3D Tab position 0.5 inch or 720 twips from the left margin. \aspalpha =3D Auto spacing between DBC and English. \aspnum =3D Auto spacing between DBC and numbers. \faauto=3D Font alignment. The default setting for this is "Auto." \ls156 =3D list override: Should exactly match the ls for one of the = list overrides in the List Override table. \ilvl1 =3D The 0-based level of the list to which the paragraph belongs. For all simple lists, this should always be 0. For multilevel lists, it can be 0 through 8. \outlinelevel1 =3D Outline level of paragraph. The N argument is a value from 0 to 8 representing the outline level of the paragraph. In the default case, no outline level is specified (same as body text). \adjustright =3D Automatically adjust right indent when document grid is defined. \rin0 =3D Right indent 0 for left-to-right paragraphs; left indent for right-to-left paragraphs (the default is 0). \rinN defines space after the paragraph. \lin720 =3D Left indent 0.5 inch or 720 twips for left-to-right paragraphs; right indent for right-to-left paragraphs (the default is 0). \linN defines space before the paragraph. \itap0 =3D Paragraph nesting level, where 0 is the main document, 1 is a table cell, 2 is a nested table cell, 3 is a doubly nested table cell, and so forth. The default is 1. \b =3D bold \f1 =3D Font number N. N refers to an entry in the font table. \fs28 =3D 14 points. Font size in half-points (the default is 24). \lang1033 =3D language English: Applies a language to a character. N is = a number corresponding to a language. \langfe1033 =3D language English: Applies a language to a character. N = is a number corresponding to a language. \kerning32 =3D Kern fonts above 16 points (32 half points) \langnp1033 =3D language English: Applies a language to a character. N = is a number corresponding to a language. The \plain control word resets the language property to the language defined by \deflangN in the document properties. It is identical to \langN, but needed when \noproof is written together with \lang1024 in order to preserve the language of the text that is not being checked for spelling or grammar. Usually follows \langN. \snext =3D the style of the following paragraph is style number 15 2_Heading =3D the "mapped to" name: the style name that corresponds to our defined style. Note: If you use a Custom Global Template in Word, it is not actually necessary to change the actual style definition to match. Tools-->Options, Automatically update styles will change the fonts and spacings to match your defined styles. It is PREFERRED to have the style definition in the RTF stylesheet match the desired style, however. To change the style definition in the RTF stylesheet: 1. Create a blank document in Word. 2. Select Format-->Styles to see all styles in use. 3. DELETE ALL STYLES POSSIBLE. 4. Create the desired style(s) in the blank document in Word. VERY IMPORTANT: Do NOT use the Word "built-in" style names. 5. Save the document as <filename>.doc 6. Save As an RTF document <filename>.RTF 7. (Highly recommended!) Save As a Custom Global Template <filename>.dot in the specific path: C:\Documents and Settings\username\Application Data\Microsoft\Templates 8. Open the Doxygen RTF Style sheet (Generate one if necessary.) 9. Open the RTF document in a TEXT editor. 10. Locate the style definition (search for your style name) in the RTF document. 11. Copy everything AFTER "\sN" (style number N) through the end of the style (your style name). 11. Locate the "Map to" style in the Doxygen RTF Style sheet. 12. Select everything past "\sN" (style number N) through the end of the style (default style name) 13. Paste. 14. Save As <My_Stylesheet>.txt. (Do not keep the default name.) 15. Repeat steps 10 through 13 for each style to be mapped. 16. Set Doxygen to look for your style sheet. The Global Template should be added and attached to all documents created. It will "instantly" fix the styles. Regards,=20 Larry Randall =20 =20 -----Original Message----- From: dox...@li... [mailto:dox...@li...] On Behalf Of Michael A. Kolakowski Sent: Tuesday, June 13, 2006 10:05 To: dox...@li... Subject: [Doxygen-users] rtf style and extensions Does anyone have any experience with the rtf stylesheet and extensions? I generated the default extensions, and it all seems simple enough. =20 However, the only thing that shows up is the company name. The other=20 things don't show up, such as the title. The first page still just=20 says, "TITLE" and "AUTHOR" and "CREATE DATE". I tried putting stuff in=20 double quotes, single quotes, and no quotes. Also, I generated the stylesheet and have no idea what's going on=20 there. I tried commenting and uncommenting a bunch of lines and there=20 seemed to be no change. Thanks, --=20 Michael Kolakowski CCN-12 505-606-0934 ------------------------------------------------------------------------ - 'Honest, boss, there's nobody here but us complicated thinking machines.' _______________________________________________ Doxygen-users mailing list Dox...@li... https://lists.sourceforge.net/lists/listinfo/doxygen-users |
