Disclaimer - The MIF Doclet is experimental code developed for internal use at Sun and released to the developer community for use as-is. It is not a supported product. Use at your own risk. While we have worked to make it useful, bugs might not be fixed and features might not be added. It might not be updated, and might be re-released with a different implementation or GUI design that is incompatible with the current design.Contents
Testing Note - The MIF Doclet has been tested with the Solaris version of FrameMaker 5.5. If you test it with other FrameMaker versions and other operating systems and determine that it does or does not work, please let us know so we can mention it.
The MIF Doclet is an extension to Javadoc that generates API documentation in MIF (Maker Interchange Format) from declarations and doc comments in source code in the JavaTM programming language. These MIF documents can then be opened in Adobe FrameMaker and optionally converted to PDF, PostScript, Microsoft RTF, Microsoft Word or WordPerfect.The MIF Doclet works only with version 1.2.2 or later of the Java 2 SDK, Standard Edition.
FrameMaker batch processing programs can automate converting MIF files to other formats, such as FrameMaker native binary format, PostScript and PDF formats. There are two such batch processing programs available:
fmbatch
anddzbatcher
.The goal was to create a general, flexible MIF Doclet that can be customized for your own FrameMaker styles. It tries to replicate much of the content generated by the standard HTML doclet. However, the page layout has been modified slightly from the standard HTML doclet to reduce vertical space, for print documentation, where page count needs to be conserved. To obtain denser content, we put subheadings and data on the same line where possible (rather than two lines), and eliminated repetition, by removing the "first sentence" from the index. We also added an option to allow removing the "first sentence" from the member summary.
Benefits
The benefits of a MIF Doclet over the standard HTML doclet are:The MIF Doclet has advantages over the tool
- Easily printable API documents - PostScript and PDF can be generated from MIF using FrameMaker. With batch processors
fmbatch
ordzbatcher
, you can print an entire package or set of packages with a single command.- Easily publishable API books - The MIF Doclet can generate headers, footers, a table of contents and an index, with page numbering, for a complete book. This makes it possible to nearly automate the publishing of API books.
- Inclusion of API docs into documents written in FrameMaker - MIF-generated API docs can be appended to FrameMaker documents to make a complete document for distribution. This tightly binds the API and non-API sections for easier download, review and tracking.
- Easy conversion to other formats - Can convert to RTF, Word and WordPerfect from FrameMaker.
html2ps
in that the MIF Doclet can have custom formatting more suitable for printed documentation, and can handle images and larger numbers of classes.Features
The MIF Doclet includes these features:
- Generates a book file that contains a list of classes or packages. Has a
-split
option for listing them either by class or package. (See the limitation.) For example, when generating the documentation for thejava.applet
andjava.lang
packages with "-split package
", the book file contains:With "titlepage.fm
contents.fm
java.applet.fm
(documents all classes in thejava.applet
package)
java.lang.fm
(documents all classes in thejava.lang
package)
index.fm
-split class
", the book file contains:titlepage.fm
contents.fm
java.applet.fm
java.lang.fm
java.applet.Applet.fm
java.applet.AppletContext.fm
java.applet.AppletStub.fm
java.applet.AudioClip.fm
java.lang.Boolean.fm
java.lang.Byte.fm
java.lang.Character.fm
...
index.fm
- Generates a table of contents and index of the API with page numbers. These include cross-references into the body of text, which convert to links in PDF output. (Oddly enough, in the contents, the links are on the text and not the page numbers, while in the index, the reverse is true -- links are on the page numbers, not the text.) The MIF doclet can uses a batch processing program (
fmbatch
ordzbatcher
) to convert the MIF files to FrameMaker native binary files, and generate/update the page breaks and page numbers.
- Converts GIF images embedded in <IMG> tags to FrameMaker format.
- Has
-membersummary
option that generates, for each class, either a full summary of members with signatures and first-sentence descriptions, a compact summary with signatures only, or no member summary.
- Has
-noinheritedsummary
option that omits the inherited API from each class, for more compact output.
- Enables you to include your own custom title page (
-titlefile
).
- Allows users to provide their own FrameMaker template
template.mif
, for generating pages in their own corporate format. A style mapping properties filestylemap.properties
enables the easy renaming of FrameMaker styles that the MIF Doclet generates.Limitations
Here are some known limitations of the MIF Doclet:
- When generating one file per class, Javadoc is designed to place all classes for a given package into a package directory. However, Adobe Acrobat 3.0 cannot include properly include files from more than one directory. Therefore, generating one file per class has a distinct disadvantage. Because of this limitation, we plan to first concentrate on only the option of one file per package (controlled with the
-split
option). All package files can be included in a single directory, and a PDF file can be generated for each package, or for the set of packages.- The MIF Doclet operates on one paragraph at a time, and does not look ahead. Therefore, it currently cannot apply a unique style to the last paragraph in a series (unless it is in a table). Therefore, it cannot apply extra space after the last bulleted or numbered paragraph in a series.
- By design choice, the MIF Doclet does not generate all the pages that the standard HTML doclet generates: it does not generate "package use" pages, "class use" pages, "tree" pages, "deprecated API" pages or a help page.
- HTML Limitations - Doc comments are written in HTML, not plain text. The MIF Doclet must convert this HTML to MIF. The current MIF Doclet uses a primitive HTML parser for this, which limits the HTML that can be converted to MIF. See Doc Comment HTML Notation for more details.
The syntax is basically the Javadoc syntax with the options listed below. You invoke it using the-doclet
and-docletpath
options.javadoc -doclet com.sun.tools.doclets.mif.MIFDoclet -docletpath <path> \ [options] [packagenames] [sourcefiles] [classnames] [@files]NOTE - The MIF Doclet cannot handle[classnames]
with both the-split package
and-bookfile
options.
Options provided by Javadoc: -overview <file> Read overview documentation from HTML file -public Show only public classes and members -protected Show protected/public classes and members (default) -package Show package/protected/public classes and members -private Show all classes and members -help Display command line options -doclet <class> Generate output via alternate doclet (Note 1) -docletpath <path> Specify where to find doclet class files -1.1 Generate output using Javadoc 1.1 emulating doclet -sourcepath <pathlist> Specify where to find source files -classpath <pathlist> Specify where to find user class files -bootclasspath <pathlist> Override location of class files loaded by the bootstrap class loader -extdirs <dirlist> Override location of installed extensions -verbose Output messages about what Javadoc is doing -locale <name> Locale to be used, e.g. en_US or en_US_WIN -encoding <name> Source file encoding name -J<flag> Pass <flag> directly to the runtime system Options provided by the MIF Doclet: -d <directory> Destination directory for generated files -version Include @version paragraphs -author Include @author paragraphs -split package|class Generate one file per package (default) or class -includedir <path> Path where MIF include files are located (Note 2) -textrectid <int> Flow text into TextRectID of number <int> -tftag <text> Flow text into TFTag of letter <text> -doctitle <text> Include title for the overview page (Note 3) -link <path> Create links to excluded classes at <path> -bookfile <file> Create book file named <file> -titlefile <.mif file> Title file to be included in the generated book file -contentsfile <.mif file> Contents file to be included in the generated book file -indexfile <.mif file> Index file to be included in the generated book file (Note 4) -stylemapfile <file> File that maps internal styles to FM styles -batch fmbatch|dzbatcher Create batch files, then generate and update FM docs (Note 5) -membersummary full|compact|none Generate full, compact or no member summary -group <name> <p1>:<p2>... Group packages together in overview page -nodeprecated Do not include @deprecated information -noexecutebatch Do not execute the batch program (Note 6) -noinheritedsummary Do not generate inherited member summary infoNotes
1. The-doclet
option takes the argumentcom.sun.tools.doclets.mif.MIFDoclet
for the MIF doclet.2. The
-includedir
option points to the location ofstyles.mif
,pages.mif
, andtextflows.mif
.3. The
-doctitle
text argument is passed through without any processing. Therefore, it should not contain HTML tags. (This is in contrast to the standard HTML doclet, where the-doctitle
can contain HTML tags.)4. If no
-indexfile
is given, the fileindex-all.mif
is generated to hold the index.5. If the batch program supplied with
-batch
is not in the path, then you get an error like "File not found." For more information about the batch arguments, see Install the batch program under Setup.6. The
-noexecutebatch
option is useful when you want to create the batch files (with-batch
) but not execute them, in case you want to modify them before running them.Command-Line Help
To display the command-line help specific to the MIF Doclet, as shown above, execute javadoc with the
-doclet
,-docletpath
and-help
options. For example:javadoc \ -doclet com.sun.tools.doclets.mif.MIFDoclet \ -docletpath /usr/local/mifdoclet_C/mif.jar:\ /usr/local/mifdoclet_C/mifoutput.jar:\ /usr/local/mifdoclet_C/standarddoclet.jar \ -help
Setup
System Requirements: The MIF Doclet will run with v1.2, v1.2.1, v1.2.2 or v1.3 Beta version of Java 2 SDK. The MIF Doclet temporarily includes a jar file that contains necessary changes to the standard doclet, enabling it to run on this wide range of versions.Perform these steps before running the MIF Doclet:
- Download and unbundle the MIF Doclet bundle. This bundle contains two Java archive files:
mif.jar
andmifdoclet.jar
. You can place these wherever you want as long as the-docletpath
option points to them. In addition,-docletpath
must also point to thestandarddoclet.jar
file. [NOTE: Eventually, once some internal changes to the standard doclet have been integrated into the latest version of Javadoc,-docletpath
will be able to point instead totools.jar
file that comes with Java 2 SDK v1.3, which contains the standard doclet.]- Install the batch program - Printing or conversion from MIF to any format requires either FrameMaker or a FrameMaker batch processing program. If you want to have the MIF doclet do this automatically, you can include the
-batch
option and supply eitherfmbatch
ordzbatcher
. Be sure the program you use is located on your operating system's search path. Here are some more details:
- The
fmbatch
program is from Adobe. Ships with FrameMaker. Available only on Solaris.- The
dzbatcher
program is from Miramo and does the same thing asfmbatch
, but on more platforms. It uses slightly different syntax for batch commands (using more Windows-like terms: it usesClose <filename>
instead ofQuit <filename>
, andExit
instead ofQuit
). Available on Windows NT and soon on Solaris.Running
NOTE - For the list of known bugs, please see Changes and Bugs in MIF Doclet.The following example executes the MIF Doclet on a sample package (java.applet
) on Solaris. In addition to the above setup, it assumes the following:
- Javadoc version - You are running version 1.2.2 (or later) of Javadoc. To check this, try:
javadoc -J-version
- MIF doclet installed - The MIF Doclet has been downloaded and installed such that its files are in the directory
/usr/local/mifdoclet_C
.- Jar file location - The jar files
mif.jar
,mifdoclet.jar
andstandarddoclet.jar
[Eventually to betools.jar
.] are pointed to by the-docletpath
option.- Include files - The three "include" files
styles.mif
,pages.mif
, andtextflows.mif
are pointed to by the-includedir
option. You can use the default versions of these three files that we supply, or create your own. The doclet will copy these files to the destination directory.- Source files - The
*.java
source files to be documented are pointed to by-sourcepath
-- in this case,/java/src/share/classes
- Overview file - The overview file is pointed to by
-overview
-- in this case, it is at/java/src/share/classes/overview.html
- Destination directory - The destination directory exists and can be empty -- in this case, it is named
docs
and is a subdirectory of the current directory. The doclet will copy the front/back matter files there for you. [We plan for the next version to also copy the include files there.]- Front/back matter files - The title, contents and index FrameMaker template files are pointed to by
-titlefile
,-contentsfile
and-indexfile
, respectively. Important - Do not place these files in the destination directory, or the batch processor will overwrite them to zero length. The doclet will copy them to the destination directory for you.- Documented package - This example documents the
java.applet
packagejavadoc \ -doclet com.sun.tools.doclets.mif.MIFDoclet \ -docletpath /usr/local/mifdoclet_C/mif.jar:\ /usr/local/mifdoclet_C/mifoutput.jar:\ /usr/local/mifdoclet_C/standarddoclet.jar \ -sourcepath /java/src/share/classes \ -includedir /usr/local/mifdoclet_C \ -overview /java/src/share/classes/overview.html \ -doctitle "Java Packages" \ -group "Core Packages" "java.*" \ -membersummary compact \ -bookfile java.applet.book \ -batch fmbatch \ -titlefile /usr/local/mifdoclet_C/titlepage.mif \ -contentsfile /usr/local/mifdoclet_C/contents.mif \ -indexfile /usr/local/mifdoclet_C/index.mif \ -d docs \ java.appletIf using your own MIF include files, also use-textrectid
and-tftag
.Reviewing Generated Output
IMPORTANT - After generating the documents, you should open them in FrameMaker and scan through them visually, looking particularly for two things:Troubleshooting Generated Output
- If you have used the title page
titlepage.mif
included with the bundle, change the copyright notice on page 2 for your own company.- Inspect for HTML tags in the doc comments that might not have been properly converted to MIF. The MIF Doclet has a very primitive HTML parser for this job. It does not convert HTML tables to MIF, for instance, nor does it convert nested HTML lists. See Doc Comment HTML Notation.
Q. The characters `\\x0d` appear in the generated document. How do I eliminate this?
A. This is often a cross-platform issue. If a file, such as
package.html
is created on Windows and then the MIF Doclet is run on Solaris, the newline characters appear as `\\x0d`. The current solution is for you to convert the newline characters in the source file to those recognized by the platform that the MIF Doclet is run on.More technically, the `\\x0d` would be due to a character that exceeds 0x7F in the source file that is not being converted. When the MIF doclet translates text characters from the doc comment to FrameMaker text, it translates the characters into the FrameMaker character formats. So special characters like '\t', '>', '`', '\', '\\' are translated into '\\t', '\\>', '\\Q', '\\q', '\\\\' respectively. Also, if any character value exceeds 0x7F, then it is converted as "\\x" + Integer.toString(c, 16) + " " So, the string "\\x0d" is getting added because of some character in the source file.
Error Messages when Running the MIF Doclet
When running the MIF Doclet, here is a cryptic error message that can occur:Executing fmbatch utility on: docs/xxx.book-mif-to-fm.batch starting maker ... Frame reports error 3 "Error ???"This happens whenfmbatch
tries to execute a statement like "Open docs/java.applet.book.mif
" when that file is already open. This commonly occurs when someone runs the MIF Doclet, opens up the book file to inspect the files, then runs it again without first closing the book file. To remedy this, close the book file and try again.
Included with the MIF Doclet bundle are the following sample files:The MIF Doclet adds these three files to the book when you use the
titlepage.mif
- title page that includes a copyright notice on page 2contents.mif
- table of contents (TOC)index.mif
- index-titlefile
,-contentsfile
and-indexfile
options along with the-bookfile
option. When doing so, it sets them up as follows:
- For title page, it simply copies the file you supply without modifying or adding to it.
- For table of contents, it copies the file you supply and adds to it paragraphs tagged:
OverviewHead
PackageHead
ClassHead
IndexHead
- For index, it copies the file you supply and adds to it text from markers of type:
If you omit the index filename, it creates a file named
Index
index-all.mif
.If you use the
-batch
option (withfmbatch
ordzbatcher
), the MIF Doclet converts the MIF files to FrameMaker native binary files, and runs "Generate/Update" on the book file to update the entries and page numbers in the TOC and index.If you want to use your own template in place of these three files, you can adapt it for use with the MIF Doclet. One easy way is as follows, using the TOC as an example:
Running the MIF doclet this way (along with the
- Start with your TOC template. It can be named whatever you want -- let's call it
contents2.mif
.- Import the paragraph styles from
contents.mif
intocontents2.mif
. Make sure this file contains no generated text (no table of contents entries), except perhaps a title, such as "Contents", and headings and footers.- Run the MIF doclet with the
-contentsfile
option:-contentsfile contents2.mif
.-batch
option) will generate the table of contents with the MIF paragraph styles but with the page layout (page size, margin size, headers, footers) from your template. You can redefine the paragraph styles as you wish.Alternatively, you can rename the styles in your template to those used by the MIF doclet, or, rename the styles the MIF doclet generates to those that your template uses. This latter technique takes place in the
stylemap.properties
file.
To manually create a PDF version of your document, open the document or book file, as you desire, in FrameMaker and choose the PDF option from the Print dialog box. (The MIF doclet is not yet set up for batch printing to PDF due to a bug we have been encountering.)The MIF Doclet automatically sets up the left-hand TOC list for Acrobat with indentation as follows:
BookTitle TOCHead OverviewHead PackageHead ClassHead IndexHead(The list actually appears in alphabetic order in Acrobat Setup.) You can modify this list as you see fit, according to the Acrobat Setup procedure described later under Creating Templates.
As is well-documented, doc comments are written in HTML. The current MIF Doclet can parse and convert only simple HTML into MIF. The following lists describe which tags are handled by the MIF Doclet.
- The MIF Doclet doesn't handle:
Tables <TABLE> <TH> <TD> <TR> Fonts <FONT>- MIF Doclet does handle:
< ("less than" character) > ("greater than" character) & ("ampersand" character) " ("double-quote" character) <UL> <OL> <LI> (lists, though not nested lists) <BLOCKQUOTE> (Blockquote style) <P> (new paragraph) <TT> (Code) <CITE> (Italic) <EM> (Italic) <I> (Italic) <B> (Bold) <STRONG> (Bold) <CODE> (Code) <SUP> (Superscript) <SUB> (Subscript) <B><CODE> (BoldCode) <CODE><B> (BoldCode) <B><I> (BoldItalic) <I><B> (BoldItalic) <B><SUP> (BoldSuperscript) <SUP><B> (BoldSuperscript) <B><SUB> (BoldSubscript) <SUB><B> (BoldSubscript) <PRE> (CodeFragment) <A> (passes through untouched) (non-breaking space) ® (registered trademark) © (copyright)
You can use your own FrameMaker templates instead of the ones that Sun provides. Your FrameMaker templates can include your own custom styles, master pages and so forth. Using your own title page, table of contents and index is relatively simple, and is described above at Setting Up the Title Page, TOC and Index. To provide your own formatting and page layout for all the pages between the table of contents and index -- that is, the overview, package and class pages -- follow these three basic steps:These step are covered in the following sections, after "include" files are described.
- Creating templates
- Creating three MIF "include" files from your template
- Modifying the
stylemap.properties
fileThe Include Files
When running the MIF Doclet, you must place three "include" files in the destination directory. You can use the ones provided with the MIF Doclet, for the default styles and page layouts, or create your own "include" files instead, if you want to use your own custom templates.When you place these three files in the same directory as the generated MIF documents, the process of opening the generated files in FrameMaker (or in
fmbatch
) causes these three files to be merged into the document, producing the layout and formatting you want. (Each generated MIF file contains three corresponding<include>
MIF commands.)The three include files for the normal body pages are:
The following figure illustrates how a complete MIF file is structured. It delineates which parts of your template will be extracted for the three include files.
styles.mif
- Contains the definitions for paragraph styles, character (font) styles, colors, conditional text, tables, variables, cross-references, and so forth.pages.mif
- Contains the master and reference pages.textflows.mif
- Contains the text flow regions, which contain<TextRect>
regions. The actual text content is appended as the last text flow in the document, after the includedtextflows.mif
.
<MIFFile> ######################################## # Control Statements # # Macro Statements # # <ColorCatalog> # <ConditionCatalog> # <PgfCatalog> # <FontCatalog> # styles.mif <RulingCatalog> # <TblCatalog> # <Views> # <VariableFormats> # <XRefFormats> # <Document> # <BookComponent> # <InitialAutoNums> # # ######################################## <Dictionary> <Aframes> <Tbls> ######################################## # <Page> # <Page> # pages.mif <Page> # # ######################################## ######################################## # <TextFlow> # <TextFlow> # textflows.mif <TextFlow> # # ######################################## <TextFlow> (last text flow, to delete)Creating Templates
If you prefer to alter the appearance of the MIF doclet's default format and layout, the first step is to create your own FrameMaker templates. You can have three different templates -- one each for the table of contents, the body pages, and the index. For each template, take any FrameMaker file you want and modify it as you desire. You can modify:The Acrobat Setup determines which headings appear in the left-hand table of contents in a PDF file. To set these headings, in the FrameMaker template, go to Format menu, Document submenu, and choose Acrobat Setup. Move the headings you want to the left-hand list. (You can also set the Acrobat Setup in the Print dialog box.)
- Paragraph styles
- Character styles
- Master pages (page layouts)
- Reference pages
- Table formats
- Variable definitions
- Cross-reference formats
- Acrobat setup
The MIF Doclet does not currently support conditional text. The MIF doclet might support other formats we have not tested, such as document properties and color definitions.
Apply to the first page of the template the master page you want to be the default. For example, for the table of contents, we chose "TOC/Index Opener" master page for the first page.
Creating Include Files
This procedure creates the include files (styles.mif, pages.mif, and textflows.mif) necessary for running the MIF Doclet using your own FrameMaker template. Run through the procedure once to generate a set of three include files. This job is easier if the template is relatively empty of text (that is, there is less text to search through).At this point, the three MIF include files are created. To use these files, you must include the
- As described in the previous section, in FrameMaker, create the template as you desire. Save a MIF version of this file.
- In a text editor, open the MIF version created in step 1. The remaining steps describe how to extract the three necessary files from this file.
- Search for the first
<PageType BodyPage>
and locate the following<TextRect>
statement. Write down the<ID>
number for this<TextRect>
for later use. (If there is more than one<TextRect>
on this, write down the ID of the first one.)- Locate the
<TextFlow>
associated with the<TextRect>
statement from the previous step by searching for "TextRectID
xx" where "xx" is the ID number from the previous step. Write down the<TFTag>
name of this<TextFlow>
. Then delete this entire<TextFlow>
, which ends at the closest following comment "end of TextFlow
". (This should be the last<TextFlow>
in the file.)- Delete all the
<Unique
num>
statements from the file.- Delete
<Dictionary>
,<AFrames>
, and<Tbls>
sections entirely (since they are specific to the original content).- Search for "
<PageNum
" (no trailing angle bracket) and delete all the<Page>
sections containing a<PageNum>
tag except for the page containing both<PageNum `1'>
and<PageType BodyPage>
. If there is no such page, renumber the first<PageNum>
to1
and keep that page.- Search for
TRNext
. For each one with a non-zero value, make sure an<ID>
tag exists somewhere in the file with the same ID number. If such an ID tag does not exist, change theTRNext
value to zero, as in<TRNext 0>
.- Create a new file called
styles.mif
and copy into it all the content starting from the second line (just below<MIFFile>
) down to but not including the first<Page>
tag.- Copy all
<Page>
definitions to a new filepages.mif
.- Copy all
<TextFlow>
definitions to a new filetextflows.mif
.- Move all three files to the MIF Doclet's destination directory (specified by the
-d
option).-textrectid
and-tftag
options with the corresponding values written down in the previous steps.Generated MIF Structure
The MIF Doclet generates MIF files that have the structure shown in the following box. The generated<TextFlow>
uses theTextRectID
number andTFTag
name passed in from the respective-textrectid
and-tftag
options.
<MIFFile 5.50> include (styles.mif) ### Dictionary, AFrames, Tbls generated from your application follow ### <Dictionary ... > <Aframes <Frame ... > <Tbls <Tbl ... > > ### include (pages.mif) include (textflows.mif) ### TextFlow generated from your application follows ### <TextFlow ... >StyleMap File
NOTE - The MIF Doclet contains a built-in copy of the defaultstylemap.properties
file. You don't need this file if you are using the default, unchanged MIF Doclet. You need this file only if you are going to modify it, providing different names or mappings of FrameMaker styles.The MIF Doclet provides a great deal of flexibility in allowing you to name your own FrameMaker styles by allowing you to assign the actual FrameMaker style names it generates. It does this with a stylemap file.
The stylemap file maps internal MIF Doclet style names to FrameMaker style names. You can modify this file to customize the MIF Doclet to use a set of FrameMaker styles from a template your company has already designed.
In the default stylemap, we have tried to maximize the number of internal styles (for maximum flexibility) and yet map those to the minimum number of FrameMaker styles (for simplicity). The initial mapping is about 130 MIF Doclet styles to 61 FrameMaker styles. You can increase the number of Framemaker styles for more refined formatting. You can also modify the entries in the stylemap file to translate the style names.
The MIF Doclet has the default
stylemap.properties
file built-in. You can copy thestylemap.properties
file, then modify the FrameMaker styles names in the right column to those of your choosing. You then load it when you run javadoc using the-stylemapfile
option with the filename as its argument. If you named the filestylemap1.properties
, you would use the option:where path is the absolute or relative path to the file. (As with any path, follow it with a forward slash '/' on Solaris or a backward slash '\' on Windows.)-stylemapfile
path/stylemap1.properties
When editing the stylemap file, you should not modify the left-hand column. The hash character '#' indicates the rest of the line is a comment. This comment is optional, and you may omit it. If you want to map to a FrameMaker file that contains a space character, enclose the name in quotes, such as:
PackageHead "Package Head" # Name of package, left aligned
mifdoclet.properties
)Some text that is displayed in the generated files does not come from the source files, but instead comes from the MIF doclet. For example, the word "Overview" on the Overview page. Such text resides in themifdoclet.properties
file. This file resides inmifdoclet.jar
. To modify the properties file, unjarmifdoclet.jar
, modify the text (as described below) and then jar the file back up.This properties file is very similar to the properties file for the standard doclet. Each entry in this file contains a variable name, an equal sign (=), followed by its value. The word "Overview" appears as follows:
mifdoclet.Overview=OverviewYou may change the word on the right of the equal sign as you desire. For example, if you prefer to use the term "Package Set" instead of overview, you could alter it to:mifdoclet.Overview=Package Set