Document objesi, Proje hakkında bilgi içeren yazdırılabilir bir rapor sağlayan bir objedir.
...
Markdown content (–md) yazılarak başlanmalıdır. Daha sonrasında yazılanlar --md ile aynı hizada olmalıdır.
- Başlık Boyutu:
Diyez(#) işareti ile başlık boyutu belirlenir. Tek diyez(#) en büyük başlık için kullanılırken, altı adet diyez(######) en küçük başlık için kullanılır. Diyez sayısını arttırmak başlık boyutunu küçültür.
- Başlık Büyüklüğü
Eşittir işareti(=) ve kısa çizgi(-) işaretleri ile başlık büyüklüğü belirlenir. Eşittir işareti, kısa çizgi işaretine kıyasla daha büyük bir yazı yazılmasına yardımcı olur. Başlık olacak kelimelerin altını dolduracak şekilde kısa çizgi veya eşittir işareti koyularak kullanılır.
...
![Logo](ResimLinki "Resimin üzerine geldiğinde okunan yazı") ![Logo] yazdıktan sonra parantez içerisinde resimin linki ve Çift Tırnak(" ") işaretleri içerisine yazının üzerine geldiğimizde okunması istenilen yazı yazılır.
- Diğer Text objelerinde olduğu gibi, DocText objesinde de bir parametrenin değerinin verilmesi istenilen parametre isimleri || işaretleri arasına yazılır.
Örnek:
Code Block | ||||
---|---|---|---|---|
| ||||
<P N="d" V="15.21" /> <O N="Doc 1" T="Document"> <O T="DocText"> --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** ###### Lists: 1. Item 1 2. Item 2 3. Item 3 ### Tables: | Tables | Are | Cool | |: ------------- |:-------------:| -----:| | **col 3 is** | right-aligned | $1600 | | col 2 is | *centered* | $12 | | zebra |d| s | ~~are neat~~ | $1 | |d| again |d| ## Task Lists - [x] checked list item - [ ] unchecked list item ## Code Blocks ``` x = 0 x = 2 + 2 what is x ``` ## Emoji this is a :smile: smile emoji ## Images ![Logo](https://aecbolt.com/img/logo_256.png "Logo Title Text 1") </O> </O> |
...
Sınıfı | Zorunluluk | Adı | Değeri | Tipi | |
Obj3D | Zorunlu | N="Obj3D" | 3D Objenin adı | 3D Objenin tipi (Surface, Circle, Volume, Line veya group ) |
Örnek:
Code Block | ||||
---|---|---|---|---|
| ||||
<O T="DocSection" Title="Mesnet"> <O T="Doc3D" Width="600" Height="300"> <P N="Obj3D" V="MesnetA" /> </O> </O> |
...
Bu obje ile belgede projenin veya istenilen objenin 2D çizimleri görüntülenebilir.
Parametreleri:
Sınıfı | Zorunluluk | Açıklama | Örnek | |
1 | Width | Zorunlu | Görüntünün piksel cinsinden genişliği. | Width="600" |
2 | Height | Zorunlu | Görüntünün piksel cinsinden yüksekliği. | Height="400" |
Parametreleri:
Sınıfı | Zorunluluk | Adı | Değeri | Tipi | |
CADD | Zorunlu | N="CADD" | CADD veya CADDFrom3D objesinin adı | T="CADD" |
Örnek:
Code Block | ||||
---|---|---|---|---|
| ||||
<O T="DocSection" Title="CADD Çizimi "> <O T="DocText"> Dökümanın bu bölümünde 3D objenin 2D CADD çizimleri verilecektir. </O> <O T="DocText"> Yandan görünüm: </O> <O T="DocCADD" Width="600" Height="400"> <P N="CADD" V="XX" T="CADDFrom3D" /> </O> <O T="DocText"> Yukarıdan görünüm: </O> <O T="DocCADD" Width="600" Height="400"> <P N="CADD" V="ZZ" T="CADDFrom3D" /> </O> </O> |
5)DocCode Objesi
Bu obje belgede ParamML kodunu göstermeye yarar.
Örnek:eklenecek
6)DocGraph Objesi
Bu obje ile belgede lineer grafikler gösterilebilir.
Parametreleri:
Sınıfı | Zorunluluk | Açıklama | Örnek | |
1 | Title | Zorunlu | Grafik içinde belirtilen başlık. | Title="Graph 1" |
2 | Width | Zorunlu | Görüntünün piksel cinsinden genişliği. | Width="600" |
Height | Zorunlu | Görüntünün piksel cinsinden yüksekliği. | Height="400" | |
4 | AxisLabelX | Zorunlu | X ekseninde olan değişkenin adı | AxisLabelX="Width" |
5 | AxisLabelY | Zorunlu | Y ekseninde olan değişkenin adı | AxisLabelY="Height" |
6 | DataList | Zorunlu | X ekseni ve Y ekseni boyunca çizilecek veriler. V="[X, Y]" | DataList="[0,0],[8,16],[12,28]" |
Örnek:
Code Block | ||||
---|---|---|---|---|
| ||||
<O T="DocGraph" Width="400" Height="300" Title="Örnek bir X grafiği" DataList="[[0,0],[1,3],[2,4],[3,4.5],[4,4.75],[5,4.75],[6,4.5]]" AxisLabelY="Kuvvet(N)" AxisLabelX="Ölçü Boyu(mm)" /> |
...
Sınıfı | Zorunluluk | Adı | Amacı | Tipi | |
1 | DocRow | Zorunlu | N="DocRow" | Tabloya bir satır ekler | T="DocRow" |
2 | DocCell | Zorunlu | N="DocCell" | Tabloya bir sütun ekler | T="DocCell" |
Örnek:
Code Block | ||||
---|---|---|---|---|
| ||||
<O T="DocTable"> <O T="DocRow"> <O T="DocCell"> Beton Sınıfı </O> <O T="DocCell"> Karakteristik basınç dayanımı fck (MPa) </O> <O T="DocCell"> Karakteristik eksenel çekme dayanımı 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> |
...
Bu obje ile belge içerisinde 'parametre girdi kutusunu' oluşturup göstermeyi sağlar. Bu kutucuk ile tıpkı library'de olduğu gibi parametre değeri ParamML kodu değiştirilmeden belge üzerinden değiştirilebilir.
Örnek:
Code Block | ||||
---|---|---|---|---|
| ||||
<O T="DocInput" Param="width" /> <O T="DocInput" Param="height" /> |
...
Bu obje ile belgeye fotoğraf eklenebilir.
Örnek:
Code Block | ||||
---|---|---|---|---|
| ||||
<O T="DocSection" Title="Fotoğraf "> <O T="DocImage" Image="https://aecbolt.com/img/logo_256.png" /> </O> |
...