Script your Documentation

2020-02-27T13:47:54.986000Z

Hi Oleg,

it is theoretically possible, but somewhat complicated.

First, your documentation should be compiled to CHM format.
In your installation Folder there is a \CODESYS\Online Help\Extensions\$PROFILE$ folder with structure and urlmapping files in XML format. Your CHM files has to be in some Language folder and the structure file has to be modifed in that way to point to specific entries in the CHM files. That is called merging and is what some OEMs do.

Regards,
Roman

Script your Documentation

2020-02-27T13:47:54.929000Z

Originally created by: OW_RPi

Hi,

I followed the instruction of "Script your Documentation" and generated the documetation files.

How to add my documentation to the context-sensitive help now?

Thank you!

Best regards,
Oleg

Script your Documentation

2020-02-27T13:47:54.884000Z

I found the answer to most of my questions myself

So I have to specify the attributes which should be cleaned in the clean.conf
xyz.json from doc-export
"libdoc clean" command in the command line (specification with the "clean.conf" file)
xyz_cleaned.json will be created
"libdoc generate" command to get the Frame

One question is left.
I s it possible to define some parts of the rst with different attributes ?

{attribute 'hide_on_zzz'}
/// clean this section if zzz is the attribute
{attribute 'hide_on_yyy'}
/// clean this section if yyy is the attribute
///
/// | This text should always show up in the documentation:
/// | prog prog prog
/// | tock tock tock and so on

Script your Documentation

2020-02-27T13:47:54.837000Z

M.Keller hat geschrieben:

Hello,

perhaps it is a stupid question, but I am not familiar with attributes and access specifier.
Is there any Dokument or Tutorial for the use of the attributes?

I know that i can use compiler defines as an attribute.
So i tell (write a keyword in the project -> properties -> compiler definitions) the Programm which attributes to use.
And in the Code there i use {IF defined(compiler definition)}.

But how does it work with the restructured Text ? And where do I specify which attribute I want to use ?

Yours sincerely
Florian

Script your Documentation

2020-02-27T13:47:54.787000Z

Hello,

I will send the files in a few days. Until now the merge process isn't this important for me.

At the moment I'm working on the template .rst files in DocScripting/3.5.5.0/templates.

The template folder.rst lists the actual toctree with the code:

{% if toc %}
.. toctree::
:maxdepth: 1

{% for t in toc %}
{{ t }}

{% endif %}

My target is to sort the items in the toc after their type.
Something like

FBs

Eintrag_1
Eintrag_2

Folders

Folder_1
Folder_2

Is that possible ?

Is there a dokumentation for the properties of the different objekts ?
Like:
<libdoc.content.fparticle object="" at="" 0x032d0a30="">
<libdoc.content.content 0x03276190="" object="" at=""></libdoc.content.content></libdoc.content.fparticle>

Script your Documentation

2020-02-27T13:47:54.743000Z

Hello Infusion.

It seems there is some inconsistency between the files. We need to have a look at the files to find your problem.

Could you send an eMail with the problem description, the library and the generated content to the CODESYS support?

BR
Martin

Script your Documentation

2020-02-27T13:47:54.694000Z

Another failure occured

when I want to merge my Content and my Frame.
In the command line I type this:
libdoc merge %JsonFilePath% Frame Source

so I change my directory to the folder I work in and there I search for the .json File
--> JsonFilePath

also the Frame nad the Source folder are in this Path.

But I get the followinf Error message:

Traceback (most recent call last):
File "<string>", line 126, in <module>
File "<string>", line 121, in main
File "D:\Development\Python\LibDoc-3\build\libdoc\out00-PYZ.pyz\libdoc.merge",
line 75, in merge
File "D:\Development\Python\LibDoc-3\build\libdoc\out00-PYZ.pyz\libdoc.merge",
line 127, in _merge_file
File "D:\Development\Python\LibDoc-3\build\libdoc\out00-PYZ.pyz\jinja2.environ
ment", line 969, in render
File "D:\Development\Python\LibDoc-3\build\libdoc\out00-PYZ.pyz\jinja2.environ
ment", line 742, in handle_exception
File "<template>", line 22, in top-level template code
File "D:\Development\Python\LibDoc-3\build\libdoc\out00-PYZ.pyz\jinja2.environ
ment", line 397, in getattr
jinja2.exceptions.UndefinedError: 'particle' is undefined
Drücken Sie eine beliebige Taste . . .</template></string></module></string>

Script your Documentation

2020-02-27T13:47:54.649000Z

Hello,

I will try the attributes as soon as possible.

Thanks

Script your Documentation

2020-02-27T13:47:54.604000Z

Hi Infusion.

The attribute 'libdoc_include' is deprecated.

Use the following methods to exclude the parts which you don't want in your documentation:
- Attribute 'hide'
- Attribute 'conditional_show'
- Access specifier PRIVATE
- Access specifier INTERNAL

BR
Martin

Script your Documentation

2020-02-27T13:47:54.552000Z

I wodered about the use of {attribute 'libdoc_include'}

At my programm it is written above the restructuredText in the declaration area of the FB.
But also it does not work, I alwas get the whole Library Project exported as an .json File.

I do not really know where to search for my failure.
Do I have to write the attribute into the reST text area ?

Recent posts to Script your Documentation

Script your Documentation

Script your Documentation

Script your Documentation

Script your Documentation

Script your Documentation

FBs

Folders

Script your Documentation

Script your Documentation

Script your Documentation

Script your Documentation

Script your Documentation