Add doc project

Simon De Backer
2020-08-08 21:37:18 +02:00
parent a2e62f91ed
commit 29bbc92e3f
15 changed files with 171 additions and 29 deletions

@@ -1,17 +1,31 @@
[Home](Home)
* [XML-elements](elements_XML)
* [attribute](elements_definition_attribute)
* child elements
* [uuid](elements_child_uuid)
* [names](elements_child_names)
* [name](elements_child_name)
* [informations](elements_child_informations)
* [description](elements_child_description)
* [kindInformations](elements_child_kindInformations)
* [elementInformations](elements_child_elementInformations)
* [XML-elements](elements_XML)
* [attribute](elements_definition_attribute)
* child elements
* [uuid](elements_child_uuid)
* [names](elements_child_names)
* [name](elements_child_name)
* [informations](elements_child_informations)
* [description](elements_child_description)
* [kindInformations](elements_child_kindInformations)
* [elementInformations](elements_child_elementInformations)
* [XML-project](project_XML)
* child elements
* [properties](project_child_properties)
* [newdiagrams](project_child_newdiagrams)
* [properties](project_child_properties)
* [property](project_properties_child_property)
* [newdiagrams](project_child_newdiagrams)
* [border](project_newdiagrams_child_border)
* [inset](project_newdiagrams_child_inset)
* [conductors](project_newdiagrams_child_conductors)
* [report](project_newdiagrams_child_report)
* [xrefs](project_newdiagrams_child_xrefs)
* [conductors_autonums](project_newdiagrams_child_conductors_autonums)
* [folio_autonums](project_newdiagrams_child_folio_autonums)
* [element_autonums](project_newdiagrams_child_element_autonums)
* [diagram](project_child_diagram)
* [defaultconductor](project_diagram_child_defaultconductor)
* [elements](project_diagram_child_elements)
* [conductors](project_diagram_child_conductors)
* [inputs](project_diagram_child_inputs)
* [collection](project_child_collection)
* [category](project_collection_child_category)

@@ -2,7 +2,7 @@
Example:
`<collection>`
parent : project
parent : [project](project_XML)
attribute : none

@@ -2,7 +2,7 @@
Example:
`<diagram date="20180318" filename="" cols="17" height="660" locmach="" colsize="60" plant="" rows="8" displayrows="true" freezeNewElement="false" displaycols="true" auto_page_num="" title="my_title" folio="%id/%total" version="0.80-DEV+6bece6fa8d79751d3" displayAt="bottom" author="me" freezeNewConductor="false" order="1" indexrev="" rowsize="80">`
parent : project
parent : [project](project_XML)
attribute :
* date
@@ -27,8 +27,8 @@ attribute :
* indexrev
* rowsize
## child elements
* [defaultconductor](project_diagram_child_defaultconductor)
* [elements](project_diagram_child_elements)
* [conductors](project_diagram_child_conductors)
* [inputs](project_diagram_child_inputs)
* [defaultconductor](project_diagram_child_defaultconductor)
* [elements](project_diagram_child_elements)
* [conductors](project_diagram_child_conductors)
* [inputs](project_diagram_child_inputs)

@@ -2,15 +2,17 @@
Example:
`<newdiagrams>`
parent : project
parent : [project](project_XML)
attribute : none
## child elements
* [border](project_newdiagrams_child_border)
* [inset](project_newdiagrams_child_inset)
* [conductors](project_newdiagrams_child_conductors)
* [xrefs](project_newdiagrams_child_xrefs)
* [conductors_autonums](project_newdiagrams_child_conductors_autonums)
* [element_autonums](project_newdiagrams_child_element_autonums)
* [border](project_newdiagrams_child_border)
* [inset](project_newdiagrams_child_inset)
* [conductors](project_newdiagrams_child_conductors)
* [report](project_newdiagrams_child_report)
* [xrefs](project_newdiagrams_child_xrefs)
* [conductors_autonums](project_newdiagrams_child_conductors_autonums)
* [folio_autonums](project_newdiagrams_child_folio_autonums)
* [element_autonums](project_newdiagrams_child_element_autonums)

@@ -8,5 +8,5 @@ parent : project
attribute : none
## child elements
* [property](project_properties_child_property)
* [property](project_properties_child_property)

@@ -1,11 +1,16 @@
# property
Example:
``
`<property name="savedfilename" show="1">my_project</property>`
parent : properties
parent : [properties](project_child_properties)
attribute :
* name
* name :
* savedfilename
* saveddate
* savedtime
* savedfilepath
* show
1 or 0

@@ -0,0 +1,16 @@
# border
Example:
`<border cols="17" rowsize="80" colsize="60" displaycols="true" rows="8" displayrows="true"/>`
parent : newdiagrams
attribute :
* cols
* rows
* colsize
* rowsize
* displaycols
* displayrows
## child elements
none

@@ -0,0 +1,26 @@
# conductors
Example:
`<conductors conductor_color="" bicolor="true" vertirotatetext="270" tension_protocol="" dash-size="2" conductor_section="" horizontal-alignment="AlignBottom" color2="#ff0000" text_color="#000000" numsize="7" type="multi" onetextperfolio="1" displaytext="1" vertical-alignment="AlignRight" num="_" horizrotatetext="0" condsize="1" function="" formula=""/>`
parent : [newdiagrams](project_child_newdiagrams)
attribute :
* conductor_color
* bicolor
* vertirotatetext
* tension_protocol
* dash-size
* conductor_section
* horizontal-alignment
* color2
* text_color
* numsize
* type
* onetextperfolio
* displaytext
* vertical-alignment
* num
* horizrotatetext
* condsize
* function
* formula

@@ -0,0 +1,9 @@
# conductors_autonums
Example:
`<conductors_autonums freeze_new_conductors="false" current_autonum=""/>`
parent : [newdiagrams](project_child_newdiagrams)
attribute :
* freeze_new_conductors
* current_autonum

@@ -0,0 +1,9 @@
# element_autonums
Example:
`<element_autonums current_autonum="" freeze_new_elements="false"/>`
parent : [newdiagrams](project_child_newdiagrams)
attribute :
* current_autonum
* freeze_new_elements

@@ -0,0 +1,7 @@
# folio_autonums
Example:
`<folio_autonums/>`
parent : [newdiagrams](project_child_newdiagrams)
attribute : none

@@ -0,0 +1,18 @@
# inset
Example:
`<inset title="" locmach="" date="null" author="my_name" indexrev="" folio="%id/%total" displayAt="bottom" filename="" version="" plant="" auto_page_num=""/>`
parent : [newdiagrams](project_child_newdiagrams)
attribute :
* title
* locmach
* date
* author
* indexrev
* folio
* displayAt
* filename
* version
* plant
* auto_page_num

@@ -0,0 +1,8 @@
# report
Example:
`<report label="%f-%l%c"/>`
parent : [newdiagrams](project_child_newdiagrams)
attribute :
* label

@@ -0,0 +1,10 @@
# xrefs
Example:
`<xrefs>`
parent : [newdiagrams](project_child_newdiagrams)
attribute : none
## child elements
* [xref](project_newdiagrams_xrefs_child_xref)

@@ -0,0 +1,18 @@
# xref
Example:
`<xref delayprefix="" slave_label="(%f-%l%c)" type="protection" powerprefix="" offset="40" master_label="%f-%l%c" switchprefix="" showpowerctc="false" xrefpos="AlignTop" displayhas="cross" snapto="label"/>`
parent : [xrefs](project_newdiagrams_child_xrefs)
attribute :
* delayprefix
* slave_label
* type
* powerprefix
* offset
* master_label
* switchprefix
* showpowerctc
* xrefpos
* displayhas
* snapto