Versions Compared

Version Old Version 4 New Version Current
Changes made by

mert.goktas (Unlicensed)

Harika Inanc (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagexml
 ...
 ...
    <O T="Document" Title="Document Example">
        <O T="DocSection" Title="Introduction ">
            <O T="DocText">
                Width |width|, height |height| This is an example of a text description for an object created using a ParamML parametric language
            </O>
        </O>
        <O T="DocSection" Title="3D Model ">
            <O T="DocText">
                <![CDATA[
            --md
                In this section of the document, a visual representation of the 3D object will be provided.
            ]]>
            </O>
            <O T="Doc3D" Width="600" Height="300">
                <P N="Obj3D" V="Vol" />
            </O>
        </O>
...
...

To view this example in the library, see (https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&obj=objidep9yv918v687pt0cj15xq9)

Parameters of DocSection Object:

Label

 Mandatory

 Description

 Example

1

 Title

Yes

 Title of the specified Document Section.

Title="Graph"

Title="3D Model"

2)DocText Object

Graph"

Title="3D Model"

2)DocText Object:

The text contained within this object is displayed in the designated section as paragraphs.

To begin, the text should be typed in Markdown format (--md). All subsequent text should be aligned with --md.

Example:

Code Block
languagexml
 ...
 ...

        <O T="DocSection" Title="3D Model ">
            <O T="DocText">
                <![CDATA[
            --md
                In this section of the document, a visual representation of the 3D object will be provided.
            ]]>
            </O>
            <O T="Doc3D" Width="600" Height="300">
                <P N="Obj3D" V="Vol" />
            </O>
        </O>
...
...
Image Added

Header Size: The size of the header is determined by the number of hash symbols (#) used. One hash symbol (#) is used for the largest heading, while six hash symbols (######) are used for the smallest heading. The more hash symbols used, the smaller the header size will be.

Heading Size: The size of the heading is determined by the use of equal signs (=) and hyphens (-). Equal signs result in larger text compared to hyphens. To create a heading, place either a hyphen or an equal sign beneath the text.

Printing with a Different Color (Emphasis): Text enclosed within grave accents () will be highlighted in a different color.

Font Style (Italic): Text enclosed within asterisks (* *) will be displayed in italic style.

Font Style (Bold): Text enclosed within two asterisks (** **) will be displayed in bold.

Table: Table headings are enclosed within vertical slashes ( | | ). The position of the columns in the table is determined by the use of colons ( : ) placed between the vertical slashes. If two dots are placed next to the left vertical slash, the text in that column will be aligned to the left. The opposite is true for alignment to the right. If two dots are placed next to both the left and right vertical slashes, the text will be centered within the column. The text within the vertical slashes will be displayed in the table in the same order.

Reading a Value from a Parameter: When a value is enclosed within vertical slashes ( |d| ) in the code, it is treated as a parameter.

Striking Text: Text enclosed within two tildes (~~ ~~) will be crossed out.

Creating a CheckBox: A checkbox can be created by leaving a space after one hyphen, followed by square brackets with spaces inside. If there is a space within the brackets, the checkbox will be unselected. If an "x" is used instead of a space, the checkbox will be selected.

Creating a Code Block: Text enclosed within three grave accents () will be displayed as a code block.

Creating Emoji: Emojis can be created by enclosing the emoji name within two colons (:smile:).

Creating an Image: An image can be created by typing "![Logo]", followed by the image link within parentheses and the hover text within double quotation marks (" ") after the link.

Example:

Code Block
languagexml
<O N="DocumentObject2" T="Project" Category="Document Object" TransAlignRule="Right">
    <!-- created by ParamML Examples on 10.02.2023 -->
    <P N="d" V="15.21" />
    <O N="Doc 1" T="Document">
        <O T="DocText">
            <![CDATA[
            --md
             
            # OpenBrIM Markdown
            OpenBrIM `DocText` object supports GitHub compatible markdown content which can be directly rendered inside documents and design reports.
 
            Markdown content must start following `--md` keyword. The markdown content must follow the same indentation as this keyword.
 
            Here are some of the things that are supported:
             
            ## The second largest heading
             
            This is an H1
            =============
             
            This is an H2
            -------------
 
            *This text will be italic*
            **This text will be bold**
             
            ###### Material Type Lists:
            1. Steel
            2. Concrete
            3. Wooden
 
            ### Tables:
 
            | Column Type        | Location           | Material  |
            |: ------------- |:-------------:| -----:|
            | **Column 1**  | 1stFloor | Steel |
            |  Column 2 is      | *2ndFloor*    |   Concrete |
            | Column 3 |d|   s | ~~3rd Floor~~  |    Wooden |
             
            |d| "d" Parameters Shown |d|
 
            ## Task Lists
 
            - [x] checked list item
            - [ ] unchecked list item
 
            ## Code Blocks
            ```
            Steel = ASTM A615 Grade 60 Rebar
            Concrete strength = C30
            Wooden --> oak tree bending σ=75 kg/cm'2
            ```
 
            ## Emoji
 
            this is a :smile: smile emoji
 
            ## Images
         
            ![Logo](https://openbrim.org/www/brim/assets/img/logo.png"Logo Title Text 1")
        ]]>
        </O>
    </O>
</O>
Image Added

To view this example in the library, see (https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&folder=Document+Object&obj=objidep9yv918v687pt0cj15xq9)

3)Doc3D Object

This object enables you to showcase the 3D model of the project within the document.

Code Block
languagexml
...
...
        <O T="DocSection" Title="3D Model ">
            <O T="DocText">
                <![CDATA[
            --md
                In this section of the document, a visual representation of the 3D object will be provided.
            ]]>
            </O>
            <O T="Doc3D" Width="600" Height="300">
                <P N="Obj3D" V="Vol" />
            </O>
        </O>
...
...
Image Added

Parameters of Doc3D Object:

Label

 Mandatory

 Description

 Example

1

Width

Yes

Width of the display in pixel.

Width="600"

2

Height

Yes

 Height of the display in pixel.

 Height="400"

Label

 Mandatory

Name Attribute

Value Attribute

  Type Attribute

1

Obj3D

Yes

N="Obj3D"

Name of 3D object or group.

Example: V="Pier"

Type of 3D object (Surface, Circle, Volume, Line) or group.

Example: T="Volume"; T="Group"

4)DocCADD Object:

With this object, 2D drawings of the project or the desired object can be displayed in the document.

Example:

Code Block
languagexml
Parameters of DocCADD Object:
Label
 Mandatory
 Description
 Example
1
Width
Yes
Width of the display in pixel.
Width="600"
2
Height
Yes
Height of the display in pixel.
Height="400"
Label
 Mandatory
Name Attribute
Value Attribute
 Type Attribute
1
CADD
Yes
N="CADD"
Name of CADD objects or  CADDFrom3D object .
Example: V="Elevation"
T="CADD"
5)DocCode Object:
This object serves to display the ParamML code in the document.
Example:
 Code Block
languagexml
...
...
        <O T="DocSection" Title="ParamML Code ">
            <O T="DocCode" Width="300" Height="400">
                n="Vol" t="Volume" z="height" opacity="0.9">
                <o t="Point" x="-width/2" y="width/2">
                    <o t="Point" x="-width/2" y="-width/2">
                    </o>
                </o>
            </O>
        </O>
...
...        
Image Added
6)DocGraph Object:
Using this object, linear graphics can be displayed in the document.
Example:
 Code Block
languagexml
<O N="DocumentObject3" T="Project" Category="Document Object" TransAlignRule="Right">
    <!-- created by ParamML Examples on 10.02.2023 -->
    <O N="Documentation1" T="Document">
        <O T="DocSection" Title="Scatter Graph ">
            <O N="Scatter Graph" T="DocGraph" Width="400" Height="300" Title="Forces" DataList="[[[0,0],[1,3],[2,4],[3,4.5],[4,4.75],[5,4.75],[6,4.5]],[[0,20],[1,15],[2,4],[3,4.5],[4,4.75],[5,4.75],[6,4.5]]]" AxisLabelY="Force" AxisLabelX="Station" TitleList="['Girder1','Girder2']" UnitX="in" UnitY="kip" MinX="-5" MaxX="10" MinY="-5" MaxY="30" />
        </O>
        <O T="DocSection" Title="Line And Scatter Graph ">
            <O N="Scatter Graph" T="DocGraph" Width="400" Height="300" Title="Forces" DataList="[[[0,0],[1,3],[2,4],[3,4.5],[4,4.75],[5,4.75],[6,4.5]],[[0,20],[1,15],[2,4],[3,4.5],[4,4.75],[5,4.75],[6,4.5]]]" AxisLabelY="Force" AxisLabelX="Station" TitleList="['Girder1','Girder2']" UnitX="in" UnitY="kip" MinX="-5" MaxX="10" MinY="-5" MaxY="30" PointStyle="['dash','triangle']" DrawLine="[1,0]" />
        </O>
        <O T="DocSection" Title="Pie Chart">
            <O N="Pie Chart" T="DocPieChart" Width="400" Height="300" Title="Forces" DataSets="[[20,100,40]]" Labels="['Girder1','Girder2', 'Girder3']" />
        </O>
        <O T="DocSection" Title="Doughnut Chart">
            <O N="Pie Chart" T="DocPieChart" Width="400" Height="300" Title="Forces" DataSets="[[20,100,40],[20,100,800]]" Labels="['Girder1','Girder2', 'Girder3']" Doughnut="1" />
        </O>
        <O T="DocSection" Title="Horizontal Bar Chart">
            <O N="HorizontalBarChart" T="DocHorizontalBarChart" Width="400" Height="300" Title="Forces" DataSets="[[20,100],[20,100],[54,12],[20,100],[20,100]]" Labels="['Girder1','Girder2','Girder3','Girder4','Girder5' ]" DataSetLabels="['DC1','DC2']" />
        </O>
        <O T="DocSection" Title="Vertical Bar Chart">
            <O N="HorizontalBarChart" T="DocHorizontalBarChart" Width="400" Height="300" Title="Forces" DataSets="[[20,100],[20,100],[54,12],[20,100]]" DataSetLabels="['Girder1','Girder2']" Labels="['DC1','DC2','DW','LL']" Vertical="1" />
        </O>
    </O>
</O>
Image Added
Image Added
Image Added
Image Added
Image Added
Image Added
To view this example in the library, see (https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&obj=objidlf5osn4pd1miedlk3b9on)
Parameters of DocGraph Object:
Label
 Mandatory
 Description
 Example
1
 Title
Yes
 Title indicated inside the graph.
Title="Graph 1" 
2
Width
Yes
Width of the display in pixel.
Width="600"
3
Height
Yes
 Height of the display in pixel.
 Height="400"
4
AxisLabelX
Yes
Variable name along X-axis.
AxisLabelX="Width"
5
AxisLabelY
Yes
Variable name along Y-axis.
AxisLabelY="Height"
6
DataList
Yes
Data plotted along X-axis and Y-axis.
V="[X value, Y value]"
DataList="[0,0],[8,16],[12,28] "
7)DocTable Object:
With this object, a table can be prepared and displayed in the document.
Example:
 Code Block
languagexml
...
...
<O T="DocSection" Title="28 days Concrete strength ">
            <O T="DocTable">
                <O T="DocRow">
                    <O T="DocCell">
                        concrete grade
                    </O>
                    <O T="DocCell">
                        Typical Compressive Strength fck (MPa)
                    </O>
                    <O T="DocCell">
                        Typical Axial Tension Strength fctk (MPa)
                    </O>
                </O>
                <O T="DocRow">
                    <O T="DocCell">
                        C16/20
                    </O>
                    <O T="DocCell">
                        16
                    </O>
                    <O T="DocCell">
                        1.4
                    </O>
                </O>
                <O T="DocRow">
                    <O T="DocCell">
                        C18/22
                    </O>
                    <O T="DocCell">
                        18
                    </O>
                    <O T="DocCell">
                        1.5
                    </O>
                </O>
                <O T="DocRow">
                    <O T="DocCell">
                        C20/25
                    </O>
                    <O T="DocCell">
                        20
                    </O>
                    <O T="DocCell">
                        1.6
                    </O>
                </O>
            </O>
        </O>
...
...        
Image Added
Example:
 Code Block
languagexml
<O N="DocumentObject1" T="Project" Category="Document Object" TransAlignRule="Right">
    <!-- created by ParamML Examples on 09.02.2023 -->
    <P N="width" V="20" Role="Input" />
    <P N="height" V="10" Role="Input" />
    <O N="Vol" T="Volume" Z="height" Opacity="0.9">
        <O N="surface1" T="Surface" Z="0">
            <O T="Point" X="width" Y="-width" />
            <O T="Point" X="width" Y="width" />
            <O T="Point" X="-width" Y="width" />
            <O T="Point" X="-width" Y="-width" />
        </O>
        <O N="surface2" T="Surface" Z="height">
            <O T="Point" X="width/2" Y="-width/2" />
            <O T="Point" X="width/2" Y="width/2" />
            <O T="Point" X="-width/2" Y="width/2" />
            <O T="Point" X="-width/2" Y="-width/2" />
        </O>
    </O>
    <O N="BottomSection" T="CADD" RZ="PI/2">
        <O T="CADDShape">
            <O T="Point" X="width" Y="-width" />
            <O T="Point" X="width" Y="width" />
            <O T="Point" X="-width" Y="width" />
            <O T="Point" X="-width" Y="-width" />
        </O>
    </O>
    <O N="TopSection" T="CADD" DisplayWidth="1">
        <O T="CADDShape">
            <O T="Point" X="width/2" Y="-width/2" />
            <O T="Point" X="width/2" Y="width/2" />
            <O T="Point" X="-width/2" Y="width/2" />
            <O T="Point" X="-width/2" Y="-width/2" />
        </O>
    </O>
    <O T="Document" Title="Document Example">
        <O T="DocSection" Title="Introduction ">
            <O T="DocText">
                Width |width|, height |height| This is an example of a text description for an object created using a ParamML parametric language
            </O>
        </O>
        <O T="DocSection" Title="3D Model ">
            <O T="DocText">
                <![CDATA[
            --md
                In this section of the document, a visual representation of the 3D object will be provided.
            ]]>
            </O>
            <O T="Doc3D" Width="600" Height="300">
                <P N="Obj3D" V="Vol" />
            </O>
        </O>
        <O T="DocSection" Title="CADD Drawing ">
            <O T="DocText">
                In this section of the document, a visual representation section of the 2D object will be provided.
            </O>
            <O T="DocText">
                Top Section
            </O>
            <O T="DocCADD" Width="400" Height="300">
                <P N="CADD" V="TopSection" T="CADD" />
            </O>
            <O T="DocText">
                Bottom Section
            </O>
            <O T="DocCADD" Width="400" Height="300">
                <P N="CADD" V="BottomSection" T="CADD" />
            </O>
        </O>
        <O T="DocSection" Title="ParamML Code ">
            <O T="DocCode" Width="300" Height="400">
                n="Vol" t="Volume" z="height" opacity="0.9">
                <o t="Point" x="-width/2" y="width/2">
                    <o t="Point" x="-width/2" y="-width/2">
                    </o>
                </o>
            </O>
        </O>
        <O T="DocSection" Title="Picture ">
            <O T="DocImage" Image="" />
        </O>
        <O T="DocSection" Title="Inputs">
            <O T="DocInput" Param="width" />
            <O T="DocInput" Param="height" />
        </O>
        <O T="DocSection" Title="28 days Concrete strength ">
            <O T="DocTable">
                <O T="DocRow">
                    <O T="DocCell">
                        concrete grade
                    </O>
                    <O T="DocCell">
                        Typical Compressive Strength fck (MPa)
                    </O>
                    <O T="DocCell">
                        Typical Axial Tension Strength fctk (MPa)
                    </O>
                </O>
                <O T="DocRow">
                    <O T="DocCell">
                        C16/20
                    </O>
                    <O T="DocCell">
                        16
                    </O>
                    <O T="DocCell">
                        1.4
                    </O>
                </O>
                <O T="DocRow">
                    <O T="DocCell">
                        C18/22
                    </O>
                    <O T="DocCell">
                        18
                    </O>
                    <O T="DocCell">
                        1.5
                    </O>
                </O>
                <O T="DocRow">
                    <O T="DocCell">
                        C20/25
                    </O>
                    <O T="DocCell">
                        20
                    </O>
                    <O T="DocCell">
                        1.6
                    </O>
                </O>
            </O>
        </O>
        <O T="DocSection" Title="Diagram ">
            <O T="DocGraph" Width="400" Height="300" Title="X Graph" DataList="[[0,0],[1,3],[2,4],[3,4.5],[4,4.75],[5,4.75],[6,4.5]]" AxisLabelY="Force(N)" AxisLabelX="Disp(mm)" />
        </O>
    </O>
</O>
To view this example in the library, see (https://openbrim.org/platform/?application=inc&author=ParamML_Examples_OpenBrIM+Platform&obj=objid0f7ab4sjh1fl38g9nx5clhn)
8)DocSectionAnalysis:
With this object, section analysis and calculations, such as rebar stress, flexural capacity, and interaction diagrams, can be displayed in the document. The values that affect the results can be overridden in the document, and changes in the results along the section can be reviewed instantaneously.

Example :