plc.myforum.ro Forum Index plc.myforum.ro
PLCs users www.plc.myforum.ro!
 
 FAQFAQ   SearchSearch   MemberlistMemberlist   UsergroupsUsergroups   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

TIA Portal Add-In Code2Docu for generating documentation

 
Post new topic   Reply to topic    plc.myforum.ro Forum Index -> ROSimatic
View previous topic :: View next topic  
Author Message
mamiko
Member 2
Member 2
mamiko

Joined: 25 Dec 2017
Posts: 420

PostPosted: 15/12/2023 14:33    Post subject: TIA Portal Add-In Code2Docu for generating documentation Reply with quote

TIA Portal Add-In Code2Docu for generating documentation
https://support.industry.siemens.com/cs/document/109809007/
With the help of "Code2Docu" a documentation is generated from functions (FCs), function blocks (FBs) and PLC data types of a TIA Portal project.
In defined properties and areas, functions (FCs), function blocks (FBs) and PLC data types ( in the following named as "objects") can be documented using _MarkDown_ (MD) as defined markup language. With "Code2Docu" this information and text elements are extracted from the objects, prepared for the documentation to be generated and stored accordingly.

TIA Portal Add-In Code2Docu for generating documentation TIA Portal Add-In Code2Docu for generating documentation
Code2Docu" supports the following objects:

PLC blocks (FC, FB, Safety FC, Safety FB) in the programming languages SCL, STL, FBD, LAD
PLC data types (UDT, Safety UDT / subordinate structures)
PLC constants (Global constants)

Benefits of "Code2Docu"
Reduction of engineering and coordination efforts
Time savings and thus cost reduction
Increase of engineering efficiency
Same “look and feel” for all objects and all documentations, because of template based generation
Integration in CI/CD Workflows ("Continuous Integration" / "Continuous Delivery")
Updateability of the documentation
Document style
Change history
“Single point of source”, generation of the entire documentation and the user-defined documentation (user help) from one source
All documented languages are also stored in the objects as language (multilingual)
Documentation cannot be “lost” as it is stored together with the project
Developers can document their code directly –> acceptance criterion for code documentation

Documentation, TIA Portal Add-In Code2Docu and Demo project
https://support.industry.siemens.com/cs/attachments/109809007/109809007_TIA_AddIn_Code2Docu_DOC_V1_3_0_en.pdf
https://support.industry.siemens.com/cs/attachments/109809007/109809007_Code2Docu_V1.3.0.zip
https://support.industry.siemens.com/cs/attachments/109809007/109809007_TIA_AddIn_Code2Docu_PROJ_V1_3_0.zip
https://support.industry.siemens.com/cs/attachments/109809007/TIAPortalAdd-In-Code2Docu_1.3.0_READMEOSS_multilingual.html
https://support.industry.siemens.com/cs/attachments/109809007/109809007_OpenSourceSoftware.zip

[URL=https://www.file-upload.net/download-15238859/109809007_OpenSourceSoftware.zip.html]109809007_OpenSourceSoftware.zip[/URL]
[URL=https://www.file-upload.net/download-15238860/109809007_TIA_AddIn_Code2Docu_PROJ_V1_3_0.zip.html]109809007_TIA_AddIn_Code2Docu_PROJ_V1_3_0.zip[/URL]
[URL=https://www.file-upload.net/download-15238861/109809007_Code2Docu_V1.3.0.zip.html]109809007_Code2Docu_V1.3.0.zip[/URL]
[URL=https://www.file-upload.net/download-15238862/109809007_TIA_AddIn_Code2Docu_DOC_V1_3_0_en.pdf.html]109809007_TIA_AddIn_Code2Docu_DOC_V1_3_0_en.pdf[/URL]
Back to top
View user's profile Send private message
Display posts from previous:   
Post new topic   Reply to topic    plc.myforum.ro Forum Index -> ROSimatic All times are GMT + 2 Hours
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group
Fa-ti si tu propriul forum GRATUIT, pe www.myforum.ro