Package eu.bandm.tools.d2d2.base

Class UserdocUninstantiated

java.lang.Object

eu.bandm.tools.d2d2.base.Userdoc

eu.bandm.tools.d2d2.base.UserdocUninstantiated

public class UserdocUninstantiated
extends Userdoc

Create Xhtml documentation of an unresolved "raw" Module.

Usage pattern: (1) Create fresh instance
(2) call main entry method makeHtmlDoc()
(3) Then the directory (specified in (1)) will be filled with main "index.html" and many "*.png", etc.

The generated xhtml has the following structure [fileHeader] [=H1] [listOfModules] __TOC__ = anchorname_toc [preamble] // nach oben ??? //per module: [moduleHeader] [=H2] __MODULE__[x] [moduleDocText] [generics Warning] [homonymTags] [importTable] [=H3] [importItem] __IMPORTITEM__[x.z] [definitionList] [=H3] (NOT "taglist" !) //per definition: [defHeader] [=H3] __DEFINITION__[x.y] [defDocText] [syntaxGraph] [defSrcText] [defUsedIn] // ??? [defHomonyms] // ??? [defFooter] //=source and xml repr. [docuTable] [=H2] __TOC__docEntries

Nested Class Summary

Nested classes/interfaces inherited from class eu.bandm.tools.d2d2.base.Userdoc

Userdoc.RefPainter_custom

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<Module>	allModules
protected final PreimageMap<Definition,String>	defs2tag	Maps every found definition to its tag String.
protected final PreimageMap<Definition,String>	defs2tag_global	Sum of defs2tag over all modules.
protected final Multimap<String,XRegExp>	importOccurence	Maps import prefices to the definitions which make use of it.
protected final SortedMap<String,@Opt Element_a>	ref2jump	The jump for rendering a reference.
protected final SortedMap<String,String>	ref2longName	Tooltip text, explains the "tag"-text as a reference to a definition.
protected final Module	topModule
protected final String	topModuleName

Fields inherited from class eu.bandm.tools.d2d2.base.Userdoc

anchorname_listOfHomonyms, anchorname_toc, bigLogo, bodysubs, classname_alert, classname_contextpath_in_header, classname_creationcommand, classname_defcategory_in_header, classname_defname_in_header, classname_docuSurveyTable, classname_enum_intconst, classname_enumtable, classname_footertext, classname_import_recursive, classname_import_relevant, classname_import_repeat, classname_modulename_as_header_in_list, classname_modulename_in_header, classname_nestedModuleTable, classname_syntaxgraph_image, classname_text_generic, color_syntaxGraph_background_dynamic, color_syntaxGraph_background_static, docTexts, docTextXsltTransformation, docTextXsltTransformationLoaded, docu_errorstrategy, docu_prefix, el_img_pcdata, filename_contentGraph, filename_htmldoc, functionLibrary, generatedDir, generationString, hrefTooltipAlt, html_repr_empty, image_file_suffix, imageFormat, indicateGENERIC, item_in_line_separator, jumpToToc, languagecode, lineWidth, local_copy_css, local_copy_js, map_prefix, mapname_contentGraph, moduleRegistry, msg, msgMEMSTRING, prefix_anchor_definition, prefix_anchor_importitem, prefix_anchor_module, resource_position_ddfdoc_css, resource_position_ddfdoc_js, stylesheetParams, target_module_name, target_top_tag, targetcode, toctoclist, warnGeneric, xml_lineWidth

Constructor Summary

Constructors

Constructor	Description
UserdocUninstantiated(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, int debuglevel, File generatedDir, int lineWidth, ModuleRegistry moduleRegistry, Module mod, String targetcode, String generationString, NamespaceName2String stylesheetParams)	Only constructor

Method Summary

Modifier and Type	Method	Description
protected void	getHrefTooltipAlt(Reference ref, String[] result)	Callback method to deliver these three values for the graphic rendering of the given reference.
void	makeHtmlDoc()	Service Access Point callable by client.
protected void	renderImportList(Module module)
protected void	renderOneDef(Module module, String modulename, Definition def)	Generate all text for one particular definition in the main text body.
protected void	renderOneModule(Module module)	Analyze data and generate html output for one module.

Methods inherited from class eu.bandm.tools.d2d2.base.Userdoc

addJumpToToc, anchor, anchor, anchor, anchor, copyResource, do_renderDocu, error, error, error, f_renderDocu, failure, getRenderedDocu, joinAllDocStrings, jump, jump, jump, jump, jumpName, loadDocTextXsltTransformation, make_h2_with_aname, make_li_text_localhref, makeDocuTable, makeEnumTable, makePngAndMap, makePngAndMap, mtext, mtext, packTd, packTd, renderDocu, showCategory_long, showCategory_short, splitWithAlerts, warning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

topModule

protected final Module topModule

topModuleName

protected final String topModuleName

allModules

protected final Set<Module> allModules

ref2jump

protected final SortedMap<String,@Opt Element_a> ref2jump

The jump for rendering a reference. The stored value is ==null iff not found. Must be global because it is read by theallback method {@link #getHrefTooltipAlt].

ref2longName

protected final SortedMap<String,String> ref2longName

Tooltip text, explains the "tag"-text as a reference to a definition. Must be global because it is read by theallback method {@link #getHrefTooltipAlt].

importOccurence

protected final Multimap<String,XRegExp> importOccurence

Maps import prefices to the definitions which make use of it.

defs2tag

protected final PreimageMap<Definition,String> defs2tag

Maps every found definition to its tag String. Used to detect homonyms.

defs2tag_global

protected final PreimageMap<Definition,String> defs2tag_global

Sum of defs2tag over all modules.

Constructor Details

UserdocUninstantiated

public UserdocUninstantiated(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
 int debuglevel,
 File generatedDir,
 int lineWidth,
 ModuleRegistry moduleRegistry,
 Module mod,
 String targetcode,
 String generationString,
 NamespaceName2String stylesheetParams)

Only constructor

Parameters:

msg - MessageReceiver

debuglevel - from 0 to 100, see ModuleRegistry#setTracelevel().

generatedDir - must exist as a directory, but should be empty.

lineWidth - for the printing of the re-constructed definition fragments

generationString - . Should contain the date of creation extractable by Formats.extractDate(String) All HTML mark-up will be removed when the generation string is inserted in an XML comment.

Method Details

getHrefTooltipAlt

protected void getHrefTooltipAlt(Reference ref,
 String[] result)

Callback method to deliver these three values for the graphic rendering of the given reference.

Specified by:

getHrefTooltipAlt in class Userdoc

renderImportList

protected void renderImportList(Module module)

renderOneModule

protected void renderOneModule(Module module)

Analyze data and generate html output for one module. Find for all reference texts the link target for syntax graph rendering. Detect "undef reference" errors, possible since this module is not instantiated. The sequence of html output is

1. Print a header,
2. print the module-related docu text, iff present in the selected language,
3. call #renderOneDefinition(Definition) for all definitions contained.
4. Print a table of all import items.

renderOneDef

protected void renderOneDef(Module module,
 String modulename,
 Definition def)

Generate all text for one particular definition in the main text body.

makeHtmlDoc

public void makeHtmlDoc()

Description copied from class: Userdoc

Service Access Point callable by client.

Specified by:

makeHtmlDoc in class Userdoc