C# Class IfcDoc.DocumentationISO

Exibir arquivo Open project: BuildingSMART/IfcDoc

Public Methods

Method Description
DoExport ( DocProject docProject, string filepath, DocModelView views, string locales, DocDefinitionScopeEnum scope, SEntity>.Dictionary instances ) : void

Exports file according to format.
Generate ( DocProject docProject, string path, SEntity>.Dictionary instances, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, DocPublication publications, BackgroundWorker worker, IfcDoc.FormProgress formProgress ) : void
GeneratePublication ( DocProject docProject, string path, SEntity>.Dictionary instances, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, DocPublication docPublication, BackgroundWorker worker, IfcDoc.FormProgress formProgress ) : void
MakeLinkName ( DocObject docobj ) : string

Generates HTTP-compatible name for object

Private Methods

Method Description
AppendRequirement ( StringBuilder sb, DocExchangeRequirementEnum req, int level ) : void
BuildExampleList ( List listExample, DocExample docExample, DocObject docObject, bool>.Dictionary included ) : void
CopyFiles ( string sourcepath, string targetpath ) : void

Copies files and folders recursively, skipping those that already exist.
FindTemplateItems ( DocProject docProject, DocEntity entity, DocTemplateDefinition template, DocModelView view ) : DocTemplateItem[]

Builds list of items in order, using inherited concepts.
FormatConcept ( DocProject docProject, DocEntity entity, DocConceptRoot root, DocTemplateUsage usage, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, List listFigures, List listTables, string path, DocPublication docPublication ) : string

Formats a template given an entity and optional template
FormatConceptTable ( DocProject docProject, DocModelView docModelView, DocEntity entity, DocConceptRoot root, DocTemplateUsage usage, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema ) : string

FormatDiagram ( DocProject docProject, DocObject def, DocModelView docView, List listFigures, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, string path ) : string
FormatEntityConcepts ( DocProject docProject, DocEntity entity, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, bool>.Dictionary included, List listFigures, List listTables, string path, DocPublication docPublication ) : string
FormatEntityDescription ( DocProject docProject, DocEntity entity, List listFigures, List listTables ) : string
FormatEntityUsage ( DocProject docProject, DocEntity entity, DocConceptRoot docRoot, DocTemplateUsage eachusage, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, List listFigures, List listTables, bool>.Dictionary included, StringBuilder sb, string path, DocPublication docPublication ) : void
FormatExchange ( DocProject docProject, DocModelView docView, DocExchangeDefinition def, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, DocPublication docPublication ) : string

Formats table for single exchange
FormatField ( DocProject docProject, string content, string fieldname, string fieldtype, string fieldvalue ) : string
FormatFigure ( DocProject docProject, DocObject definition, DocTemplateDefinition dtd, string caption, List listFigures, string path ) : string

If matching figure exists, generates HTML including the figure and increments the figure count.
FormatReference ( DocProject docProject, string value ) : string
FormatRequirements ( DocTemplateUsage eachusage, DocModelView docModel, bool showexchanges ) : string
FormatTemplate ( DocProject docProject, DocTemplateDefinition def, List listFigures, List listTables, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, bool>.Dictionary included, string path ) : string
FormatView ( DocProject docProject, DocModelView docView, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema ) : string

Formats table for all exchanges within a view
GenerateExample ( DocProject docProject, DocPublication docPublication, DocExample docExample, List listFormats, string path, List indexpath, bool>.Dictionary included, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, Type>.Dictionary typemap, List listFigures, List listTables, FormatHTM htmTOC, FormatHTM htmSectionTOC, IFormatData>.Dictionary mapFormats, SEntity>.Dictionary outerinstancemap, SEntity outerinstanceroot ) : void
GenerateExampleLink ( List path, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, bool>.Dictionary included, DocPublication docPublication, string dirpath ) : void

GenerateTemplate ( DocProject docProject, DocTemplateDefinition docTemplate, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, bool>.Dictionary included, int indexpath, List listFigures, List listTables, DocPublication docPublication, string path ) : void

Generates documentation for template and all sub-templates recursively.
GenerateTemplateLink ( List path, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, bool>.Dictionary included, DocPublication docPublication, string dirpath ) : void

UpdateNumbering ( string html, List listFigures, List listTables, DocObject target ) : string

Updates content containing figure references
UpdateNumbering ( string html, string tag, string style, List listRef, DocObject target ) : string

Updates numbering of figures or tables within HTML text

Method Details

DoExport() public static method

Exports file according to format.
public static DoExport ( DocProject docProject, string filepath, DocModelView views, string locales, DocDefinitionScopeEnum scope, SEntity>.Dictionary instances ) : void
docProject DocProject
filepath string File path to export.
views DocModelView Optional filter of views to export.
locales string Optional filter of locales to export.
scope DocDefinitionScopeEnum
instances SEntity>.Dictionary
return void

Generate() public static method

public static Generate ( DocProject docProject, string path, SEntity>.Dictionary instances, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, DocPublication publications, BackgroundWorker worker, IfcDoc.FormProgress formProgress ) : void
docProject DocProject
path string
instances SEntity>.Dictionary
mapEntity DocObject>.Dictionary
mapSchema string>.Dictionary
publications DocPublication
worker System.ComponentModel.BackgroundWorker
formProgress IfcDoc.FormProgress
return void

GeneratePublication() public static method

public static GeneratePublication ( DocProject docProject, string path, SEntity>.Dictionary instances, DocObject>.Dictionary mapEntity, string>.Dictionary mapSchema, DocPublication docPublication, BackgroundWorker worker, IfcDoc.FormProgress formProgress ) : void
docProject DocProject
path string
instances SEntity>.Dictionary
mapEntity DocObject>.Dictionary
mapSchema string>.Dictionary
docPublication DocPublication
worker System.ComponentModel.BackgroundWorker
formProgress IfcDoc.FormProgress
return void

MakeLinkName() public static method

Generates HTTP-compatible name for object
public static MakeLinkName ( DocObject docobj ) : string
docobj DocObject
return string