Document Objesi

"Document" Objesi, proje hakkında bilgi içeren yazdırılabilir bir rapor sağlayan bir objedir.

Parametreleri:

                  Alt öğeleri:

1)DocSection Objesi

Bu obje oluşturulacak belgeyi bölümlere ayırır. Ayrıca belgede daha kolay gezinmek için ve diğer bölümlerle bağlantıyı sağlayan bir kenar çubuğu üretir.

Parametreleri:

2)DocText Objesi

Bu obje içerisinde yazılan metni, paragraf formunda istenilen bölümde görüntüler.

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.    

• Farklı Renkle Yazdırmak ( Vurgu )

                       Grave accent( `  ` ) işaretleri arasına yazılanlar farklı renkte vurgulanabilir. 

• Yazı Tipi Stili (Italic)  

                       Yıldız işaretleri(*  *) arasına yazılanları italic tarzda yazar. 

• Yazı Tipi Stili (Kalınlık)

                       İkişer adet olan yıldızlar (**  **) arasına yazılanları kalın yazdırır.  

• Tablo

                      Vertical Slash(  |   |  ) işaretleri arasına tablo başlıkları yazıldıktan sonra tablodaki sütunların içine yazılanların hangi tarafa yatkın yazılacağına, yine vertical slash işaretleri arasına koyacağımız  iki nokta( : ) işaretini  kullanarak belirleriz. İki nokta sol vertical slash'ın yanına yazılırsa tablonun o sütununa yazılanlar sol tarafa yatkın yazılır. Sağ tarafa yazılırsa da tam tersi kullanım olur. İki nokta hem sağ ve hem sol tarafa yatkın yazılırsa , tabloda yazılanlar tam ortalanacaktır.  Daha sonra da yine vertical slash'lar arasına sırayla yazılanlar da tabloda sırayla yazılacaktır.  

• Parametreden Değer Okumak

                       Kodda parametre olarak bir değeri Vertical Slash ( |d| ) işaretleri arasına yazıldığında parametre olarak değerini alır.  

• Yazının Üstünü Çizmek

                       İkişer adet olan tilde ( ~~  ~~ ) arasına yazılanların üzerini çizerek yazar.  

• Tıklanabilir Kutu(CheckBox) Oluşturmak

                       Bir adet kısa çizgiden sonra boşluk bırakılır ve köşeli  parantez oluşturulur(İçinde boşluk olacak şekilde). İçinde boşluk olursa seçilmemiş bir checkBox olur. Fakat içinde boşluk yerine x olursa seçilmiş bir checkbox olur.

• Code Block Oluşturmak

                      Üçer adet Grave accent arasına ( ```   ``` ) yazılanlar Code Block içinde yazılır.

• Emoji Oluşturmak

                      İki adet iki nokta arasına ( :smile: ) emoji ismi yazıldığında emoji oluşur.

• Resim Oluşturmak

                        ![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:

<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>

Yukarıdaki örneğin görünümü şu şekildedir:

3)Doc3D Objesi

Bu obje belgede projenin 3D modelini görüntülemeyi sağlar.

Parametreleri:

Parametreleri:

Örnek:

<O T="DocSection" Title="Mesnet">
    <O T="Doc3D" Width="600" Height="300">
        <P N="Obj3D" V="MesnetA" />
    </O>
</O>

4)DocCADD Objesi

Bu obje ile belgede projenin veya istenilen objenin 2D çizimleri görüntülenebilir.

Parametreleri:

Parametreleri:

Örnek:

<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:

Örnek:

<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)" />

7)DocTable Objesi

Bu obje ile belge içerisinde bir tablo hazırlanıp görüntülenebilir.

Parametreleri:

Örnek:

<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>

Yukarıda belirtilmiş her bir renk bir satırı temsil eder. Satırların içerisindeki DocCell objeleri ise bu satırın hizasındaki sırasıyla hücreleri belirtir ve aşağıdaki tablo oluşur.

Tablo içerisine bir parametrenin değeri yazılmak isteniyorsa aynı Text objelerinde olduğu gibi || işaretleri arasına yazılan bir parametrenin sayısal değeri tabloda görünecektir.

8)DocInput Objesi

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:

<O T="DocInput" Param="width" />

<O T="DocInput" Param="height" />

9)DocImage Objesi

Bu obje ile belgeye fotoğraf eklenebilir.

Örnek:

<O T="DocSection" Title="Fotoğraf ">
    <O T="DocImage" Image="https://aecbolt.com/img/logo_256.png" />
</O>