...
| Label | Mandatory | Description | Example |
|---|
| 1 | Title | Yes | Title of the specified Document Section.
| Title="Graph" Title="3D Model" |
2)DocText Object:
The text contained within this object is displayed in the designated section as paragraphs.
...
Example:
| Code Block |
|---|
| <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 |
|---|
| ...
...
<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>
...
... |
|
|
|
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" |
Example:
| Code Block |
|---|
| <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) |