From 29bbc92e3f280cf9c23171b93bff17774fb97ee3 Mon Sep 17 00:00:00 2001 From: Simon De Backer Date: Sat, 8 Aug 2020 21:37:18 +0200 Subject: [PATCH] Add doc project --- _Sidebar.md | 38 +++++++++++++------ data_files/project_child_collection.md | 2 +- data_files/project_child_diagram.md | 10 ++--- data_files/project_child_newdiagrams.md | 16 ++++---- data_files/project_child_properties.md | 2 +- data_files/project_child_property.md | 11 ++++-- .../project_newdiagrams_child_border.md | 16 ++++++++ .../project_newdiagrams_child_conductors.md | 26 +++++++++++++ ...t_newdiagrams_child_conductors_autonums.md | 9 +++++ ...ject_newdiagrams_child_element_autonums.md | 9 +++++ ...roject_newdiagrams_child_folio_autonums.md | 7 ++++ data_files/project_newdiagrams_child_inset.md | 18 +++++++++ .../project_newdiagrams_child_report.md | 8 ++++ data_files/project_newdiagrams_child_xrefs.md | 10 +++++ .../project_newdiagrams_xrefs_child_xref.md | 18 +++++++++ 15 files changed, 171 insertions(+), 29 deletions(-) create mode 100644 data_files/project_newdiagrams_child_border.md create mode 100644 data_files/project_newdiagrams_child_conductors.md create mode 100644 data_files/project_newdiagrams_child_conductors_autonums.md create mode 100644 data_files/project_newdiagrams_child_element_autonums.md create mode 100644 data_files/project_newdiagrams_child_folio_autonums.md create mode 100644 data_files/project_newdiagrams_child_inset.md create mode 100644 data_files/project_newdiagrams_child_report.md create mode 100644 data_files/project_newdiagrams_child_xrefs.md create mode 100644 data_files/project_newdiagrams_xrefs_child_xref.md diff --git a/_Sidebar.md b/_Sidebar.md index a14481e..5047b53 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -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) diff --git a/data_files/project_child_collection.md b/data_files/project_child_collection.md index 0678060..67f2f60 100644 --- a/data_files/project_child_collection.md +++ b/data_files/project_child_collection.md @@ -2,7 +2,7 @@ Example: `` -parent : project +parent : [project](project_XML) attribute : none diff --git a/data_files/project_child_diagram.md b/data_files/project_child_diagram.md index c5788bc..21135c1 100644 --- a/data_files/project_child_diagram.md +++ b/data_files/project_child_diagram.md @@ -2,7 +2,7 @@ Example: `` -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) diff --git a/data_files/project_child_newdiagrams.md b/data_files/project_child_newdiagrams.md index 0a509ec..1aa85e9 100644 --- a/data_files/project_child_newdiagrams.md +++ b/data_files/project_child_newdiagrams.md @@ -2,15 +2,17 @@ Example: `` -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) diff --git a/data_files/project_child_properties.md b/data_files/project_child_properties.md index b36cc90..4c6f420 100644 --- a/data_files/project_child_properties.md +++ b/data_files/project_child_properties.md @@ -8,5 +8,5 @@ parent : project attribute : none ## child elements - * [property](project_properties_child_property) + * [property](project_properties_child_property) diff --git a/data_files/project_child_property.md b/data_files/project_child_property.md index 3842e98..fad6c6e 100644 --- a/data_files/project_child_property.md +++ b/data_files/project_child_property.md @@ -1,11 +1,16 @@ # property Example: -`` +`my_project` -parent : properties +parent : [properties](project_child_properties) attribute : - * name + * name : + * savedfilename + * saveddate + * savedtime + * savedfilepath * show + 1 or 0 diff --git a/data_files/project_newdiagrams_child_border.md b/data_files/project_newdiagrams_child_border.md new file mode 100644 index 0000000..2fc21ae --- /dev/null +++ b/data_files/project_newdiagrams_child_border.md @@ -0,0 +1,16 @@ +# border +Example: +`` + +parent : newdiagrams + +attribute : + * cols + * rows + * colsize + * rowsize + * displaycols + * displayrows + +## child elements +none diff --git a/data_files/project_newdiagrams_child_conductors.md b/data_files/project_newdiagrams_child_conductors.md new file mode 100644 index 0000000..a91ee06 --- /dev/null +++ b/data_files/project_newdiagrams_child_conductors.md @@ -0,0 +1,26 @@ +# conductors +Example: +`` + +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 diff --git a/data_files/project_newdiagrams_child_conductors_autonums.md b/data_files/project_newdiagrams_child_conductors_autonums.md new file mode 100644 index 0000000..1165377 --- /dev/null +++ b/data_files/project_newdiagrams_child_conductors_autonums.md @@ -0,0 +1,9 @@ +# conductors_autonums +Example: +`` + +parent : [newdiagrams](project_child_newdiagrams) + +attribute : + * freeze_new_conductors + * current_autonum diff --git a/data_files/project_newdiagrams_child_element_autonums.md b/data_files/project_newdiagrams_child_element_autonums.md new file mode 100644 index 0000000..02b395b --- /dev/null +++ b/data_files/project_newdiagrams_child_element_autonums.md @@ -0,0 +1,9 @@ +# element_autonums +Example: +`` + +parent : [newdiagrams](project_child_newdiagrams) + +attribute : + * current_autonum + * freeze_new_elements diff --git a/data_files/project_newdiagrams_child_folio_autonums.md b/data_files/project_newdiagrams_child_folio_autonums.md new file mode 100644 index 0000000..b7940e5 --- /dev/null +++ b/data_files/project_newdiagrams_child_folio_autonums.md @@ -0,0 +1,7 @@ +# folio_autonums +Example: +`` + +parent : [newdiagrams](project_child_newdiagrams) + +attribute : none diff --git a/data_files/project_newdiagrams_child_inset.md b/data_files/project_newdiagrams_child_inset.md new file mode 100644 index 0000000..4cd869f --- /dev/null +++ b/data_files/project_newdiagrams_child_inset.md @@ -0,0 +1,18 @@ +# inset +Example: +`` + +parent : [newdiagrams](project_child_newdiagrams) + +attribute : + * title + * locmach + * date + * author + * indexrev + * folio + * displayAt + * filename + * version + * plant + * auto_page_num diff --git a/data_files/project_newdiagrams_child_report.md b/data_files/project_newdiagrams_child_report.md new file mode 100644 index 0000000..362c10c --- /dev/null +++ b/data_files/project_newdiagrams_child_report.md @@ -0,0 +1,8 @@ +# report +Example: +`` + +parent : [newdiagrams](project_child_newdiagrams) + +attribute : + * label diff --git a/data_files/project_newdiagrams_child_xrefs.md b/data_files/project_newdiagrams_child_xrefs.md new file mode 100644 index 0000000..1123689 --- /dev/null +++ b/data_files/project_newdiagrams_child_xrefs.md @@ -0,0 +1,10 @@ +# xrefs +Example: +`` + +parent : [newdiagrams](project_child_newdiagrams) + +attribute : none + +## child elements + * [xref](project_newdiagrams_xrefs_child_xref) diff --git a/data_files/project_newdiagrams_xrefs_child_xref.md b/data_files/project_newdiagrams_xrefs_child_xref.md new file mode 100644 index 0000000..7c12a68 --- /dev/null +++ b/data_files/project_newdiagrams_xrefs_child_xref.md @@ -0,0 +1,18 @@ +# xref +Example: +`` + +parent : [xrefs](project_newdiagrams_child_xrefs) + +attribute : + * delayprefix + * slave_label + * type + * powerprefix + * offset + * master_label + * switchprefix + * showpowerctc + * xrefpos + * displayhas + * snapto