Documentation View Modes in DocumentationDocumentation View Modes in DocumentationLIBRARY DefinitionWilfrid Utzhttps://www.adoxx.org/live/c/message_boards/find_message?p_l_id=&messageId=184442013-04-02T09:38:54Z2013-04-02T09:38:54ZConfiguration parameters br Library elements are used to specify library specific properties At least one library element with default settings has to be defined Additional library elements for library specific settings have to be added if specific settings will be used br br em EXAMPLE USAGE em br div class code span class code lines 1 span SOURCE 034 Model2SGML 034 br span class code lines 2 span nbsp nbsp nbsp nbsp br span class code lines 3 span nbsp nbsp LIBRARY br span class code lines 4 span nbsp nbsp nbsp nbsp br span class code lines 5 span nbsp nbsp LIBRARY 034 Modeltype 1 034 br span class code lines 6 span nbsp nbsp nbsp nbsp br span class code lines 7 span nbsp nbsp LIBRARY 034 Modeltype 2 034 br span class code lines 8 span nbsp nbsp nbsp nbsp br div br br The following list describes the settings of one library element Optional elements are listed in brackets br strong graphics INTEGER strong br 1 if graphics should be generated 0 if no graphics should be exported br strong mode ENUMERATION strong br The mode in which the documentation should be exported Depending on the mode different classes are visible and thus exported br strong notebookattr ENUMERATION strong br The attribute mode for the document export The name of the attributemode not the attributename key has to be specified br strong gfxformat ENUMERATION strong br The format of the graphic files e g 034 bmp 034 for bitmaps 034 jpg 034 for jpegs gfxformat only has to be specified if graphics is set to 1 Possible values are bmp jpg bmp1 bmp24 pcx8 pcx24 png emf and svg br strong gfxdpi DOUBLE strong br The dpi size for the graphics This setting only has to be specified if graphics is set to 1 br strong gfxmode ENUMERATION strong br The mode in which the graphics should be exported Depending on the mode different classes are visible and thus exported Here you can specify which modelclasses are visible in the graphics This mode can be different to the mode set in mode This setting only has to be specified if graphics is set to 1 br strong gfxorientation ENUMERATION strong br The orientation of the graphics 034 don 039 t change 034 034 unverandert 034 034 rotate left counter clockwise 034 034 um 90 nach links im Gegenuhrzeigersinn drehen 034 034 rotate right clockwise 034 034 um 90 nach rechts im Uhrzeigersinn drehen 034 034 rotate by 180 034 034 um 180 drehen 034 This setting only has to be specified if graphics is set to 1 br REMARK The gfxorientation can not be changed for graphics of type 034 emf 034 br strong gfxlayout ENUMERATION strong br The page layout for the graphics This setting only has to be specified if graphics is set to 1 br strong gfxscale INTEGER strong br The scale zoom factor applied on the page layout Default is 100 This setting only has to be specified if graphics is set to 1 br strong gfxdozoom INTEGER strong br If set to 0 only one image for each model will be generated If set to 1 for every dpi entry in gfxzoomlevels an image will be generated br strong gfxzoomlevels STRING strong br A list of dpi values For each entry an image with this size will be generated E g 034 10 40 80 120 034 br strong imagemaps INTEGER strong br If set to 1 imagemap information is exported If set to 0 no imagemaps will be generatedWilfrid Utz2013-04-02T09:38:54ZSOURCE UserVariables DefinitionWilfrid Utzhttps://www.adoxx.org/live/c/message_boards/find_message?p_l_id=&messageId=184412013-04-02T09:33:47Z2013-04-02T09:33:47ZConfiguration parameters br strong filename STRING strong br The name of the sgml file where the user variables should be written br strong var1 STRING strong br Variable declarations var1 var2 var3 for user specific variables br br EXAMPLE USAGE br div class code span class code lines 1 span SOURCE 034 UserVariable 034 br span class code lines 2 span nbsp nbsp filename attribute 034 tempfilename 034 nbsp nbsp br span class code lines 3 span nbsp nbsp var1 attribute 034 Title 034 br span class code lines 4 span nbsp nbsp var2 attribute 034 Headline 034 br span class code lines 5 span nbsp nbsp var3 attribute 034 ProjectLogo 034 br div br br The file to which the uservariables will be exported will usually be the same file as the file to which the model data is exported The sgml file which will later be parsed by jade Three variables are defined in the example Each variable can be set by the user The DSL script will insert the values entered by the user in the documentWilfrid Utz2013-04-02T09:33:47ZSOURCE AdoScript DefinitionWilfrid Utzhttps://www.adoxx.org/live/c/message_boards/find_message?p_l_id=&messageId=184382013-04-02T09:34:34Z2013-04-02T09:31:48ZConfiguration parameters br strong name STRING strong br The name of the script br strong var1 STRING strong br Variable declarations var1 var2 var3 for AdoScript variables br br em EXAMPLE USAGE em br div class code span class code lines 1 span SOURCE 034 AdoScript 034 br span class code lines 2 span nbsp nbsp name 034 Jade Converter 034 br span class code lines 3 span nbsp nbsp var1 attribute 034 sgmlfilename 034 br span class code lines 4 span nbsp nbsp var2 attribute 034 filename 034 br span class code lines 5 span nbsp nbsp var2 hugo 034 123 034 br span class code lines 6 span nbsp nbsp br span class code lines 7 span nbsp nbsp nbsp SYSTEM homedir 034 jade exe f jade log t html d 034 034 homedir 034 std2htm3 dsl 034 o 034 filename 034 034 sgmlfilename br span class code lines 8 span nbsp nbsp br div br Three variables are defined in the example The first two variables are called 034 sgmlfilename 034 034 filename 034 and are assigned the value of the settings 034 sgmlfilename 034 034 filename 034 The third variable is called 034 hugo 034 and is assigned the value 034 123 034 br The variable 034 homedir 034 is set automatically to the installation path of ADOxxWilfrid Utz2013-04-02T09:31:48ZSOURCE ModelGroups DefinitionWilfrid Utzhttps://www.adoxx.org/live/c/message_boards/find_message?p_l_id=&messageId=184322013-04-02T09:32:01Z2013-04-02T09:29:00ZConfiguration parameters br strong filename STRING strong br The name of the sgml file where the model group and model reference information should be written br strong exportall INTEGER strong br Can be either 0 or 1 If it is set to 1 all modelgroups and model references are exported If if is set to 0 only the modelreferences and their modelgroups are exported that the user has selected in the export dialog br br em EXAMPLE USAGE em br div class code span class code lines 1 span SOURCE 034 ModelGroups 034 br span class code lines 2 span nbsp nbsp filename attribute 034 tempfilename 034 nbsp nbsp br span class code lines 3 span nbsp nbsp exportall 0 br div br br The file to which the modelgroups will be exported will usually be the same file as the file to which the model data is exported The sgml file which will later be parsed by jade In the example only the model refernces which the user selects at export will be added to the documentationWilfrid Utz2013-04-02T09:29:00ZSOURCE Model2SGML DefinitionWilfrid Utzhttps://www.adoxx.org/live/c/message_boards/find_message?p_l_id=&messageId=184292013-04-02T09:32:13Z2013-04-02T09:28:00Zstrong filename STRING strong br The name of the sgml file which should be generated Usually the name of a temporary file br strong basename STRING strong br The basename used for images and the log file br strong multifilemode BOOL strong br If 1 true then for each model the related full lt model gt tag is written into a separate file The main export file just contains a simple lt model gt tag for reference which specifies the related file name br strong sortmode ENUMERATION strong br There the following possibilities br Breath wise search Default mode br Depth wise search br Lexical ordering br The sort mode influences the order in which models and their submodels are exported When exporting in depth wise mode submodels are exported directly after their supermodels When exporting in breath wise mode first all models are exported then all submodels of these models then all sub submodels etc When exporting in lexical order submodels are sorted by the modelnames br strong translation STRING strong br A list of attribute names and their translations Every name and every translation has to be surrounded by 039 039 E g Name1 Translation1 Name2 Translation2 br strong modeltypes ENUMERATIONLIST strong br If no modeltypes are set all models are exported If one or more modeltypes are listed with their modeltype names only models of these modeltypes can be exported The modeltypenames have to be separated by the character 039 039 br strong acfilter STRING strong br Here you can define Attribute Class Filters The mode defines which classes are exported the attribute mode define which attributes are exported With Attribute Class Filters the user can suppress the export of several classes relationclasses and attributes even if they are included in the export and attribute modes br strong copydocuments STRING strong br Here you can define an absolute or relative path Documents referenced with the PROGRAMCALL attribute are then copied to this path when exporting the documentation br strong checkexternfilenames INTEGER strong br If this property is set to 1 the names of external files referenced with PROGRAMCALL attributes will be checked Some systems unix ftp have problems with filenames that are not alphanumeric and lowercase If set to 1 attributes referencing such files will cause a warning when exported br strong libraryspecific INTEGER strong br If this property is set to 0 the default LIBRARY properties are applied to all models If it is set to 1 for every library specific LIBRARY properties have to be defined br strong subprocesses INTEGER strong br This property specifies if subprocesses shall also be exported by default Value 1 means 034 yes 034 value 0 means 034 no 034 br strong LIBRARY strong br Every source element contains at least one library element that defines further propertiesWilfrid Utz2013-04-02T09:28:00ZEXPORT Block DefinitionWilfrid Utzhttps://www.adoxx.org/live/c/message_boards/find_message?p_l_id=&messageId=184262013-04-02T09:32:31Z2013-04-02T09:26:29ZConfiguration parameters br strong menuname STRING strong br The text for the menuentry in the 034 Documentation 034 menu Must be unique to all other menu names in the documentation menu br strong filename STRING strong br The target filename Specifies the file to which the documentation should be written This setting is set dynamically at run time by the export dialog to the filename the user has entered br strong filedescription STRING strong br The description of the output file format This is needed for the File Choose Dialog e g 034 HTML Files 034 br strong fileextension STRING strong br The file extension of the output file This is needed for the File Choose Dialog e g 034 rtf 034 or 034 html 034 br strong temp1 STRING strong br For documentation generation temporary files are needed e g the sgml file With the temp setting temp1 temp2 filenames for temporary files can be created e g 034 C temp ado2 034 After the documentation is exported these files are deleted automatically br strong requirefile1 STRING strong br With these statements you can specify files requirefile1 034 db sgm2html dsl 034 requirefile2 034 f myfolder mypicture bmp 034 etc which are to be copied to the export destination folder After the generation these file are removed again If the files should not be removed afterwards add as well a 034 copy 034 see below statement with the same filename br If a file doesn 039 t exist an error message is displayed and the export is aborted Use 034 H 034 to specify the ADOxx installation directory For example requirefile1 034 Hboclogo gif 034 checks if the file boclogo gif is contained in the ADOxx installation directory br Use only 034 requirefile 034 for temporary required files like dsl files br Use both 034 requirefile 034 and 034 copy 034 for files needed afterwards too like pictures for html files br strong copy1 STRING strong br One or more copy settings can be set copy1 copy2 The files specified here are copied to the target directory and are not removed after generation Files starting with 034 db 034 are copied out of the ADOxx database Files specified by the 034 copy 034 statement must be specified as well with the 034 requirefile 034 statement br Use only 034 requirefile 034 for temporary required files like dsl files br Use both 034 requirefile 034 and 034 copy 034 for files needed afterwards too like pictures for html files br strong visible INTEGER strong br Set visible to 1 if a menuentry should be added to the menu 034 Documentation 034 for this EXPORT block Set visible to 0 if the corresponding menu entry for this EXPORT block should be hidden br strong charmap STRING strong br This defines the character map used for documentation export As string the filename database file or absolute file of the character map table file is expected You can either define a static or dynamic value br NOTE For compatibility reasons a special value 034 DEFAULT 034 if defined which loads the character map table defined as resource in all versions of ADOxx It contains the release language of ADOxx If charmap is not defined value 034 DEFAULT 034 is set br smarticon html rtf br If smarticon is set to html this menuentry is called when the user clicks on the smarticon When it is set to rtf the menu entry is called when the user clicks on the smarticon Only one EXPORT block may be set to html and only one to rtf This setting may not be set dynamicallyWilfrid Utz2013-04-02T09:26:29ZRE Documentation View Modes in DocumentationWilfrid Utzhttps://www.adoxx.org/live/c/message_boards/find_message?p_l_id=&messageId=184232013-04-02T09:40:12Z2013-04-02T09:18:50ZTo support multiple views during export a script based solution has to be used to generate each image for each view and use this images then in the export transformation using DSSSL The basic logic of the documentation generation using the Configuration of documentation attribute is shown in the image attached br br To include all views or selected ones the LIBRARY element more specifically the mode configuration parameter can be used By adding more than one SOURCE Model2SGML element in the EXPORT block with different settings in the LIBRARY block this could be accomplished br br Alternatively the AdoScript can be used to switch through the viewmodes and generate the images using an simple EXPORT block that only does image export here the actual DSSSL adaptation could becomes tricky but doable since it needs to follow a common naming convention for models generated from different blocks br br Details on the documentation component below br Each EXPORT block can have one or more SOURCE elements also from the same type br SYNTAX and configuration parameters below br LIBRARY specific settings can be added for the SOURCE 034 Model2SGML 034 to have a custom behaviour per modeltype library definedWilfrid Utz2013-04-02T09:18:50ZDocumentation View Modes in Documentationhttps://www.adoxx.org/live/c/message_boards/find_message?p_l_id=&messageId=184182014-03-27T12:26:31Z2013-04-02T09:17:58ZIt is unclear how it is possible to 034 tie in 034 models into documentation Models have multiple view modes and ideally the tool should generate documentation including single or multiple optionally selected views on the same document Now the graphics and the exported document is about the view mode which is currently open It would be useful to know how to force exported document include all view modes or allow the user of the tool to select combination of view modes to be documented2013-04-02T09:17:58Z