Help file editor

September 18th, 2008 | Tags: , , , ,

After many hours spent on this new help file editor, I can show you a first screen shot of this wonderful tool in action. Help files will be XML structured files with the file extension .HLP. Based on the information in the files, PPL will generated HTML Help files on the fly automatically. This way you can easily write and distribute help content with your components without having to use a third party help file editor (some are quite expansive). You need to perform help file merges and all help content on screen will be 100% consistent for all components and functions.

It has the ability to import from a component description file (XML structured file as well) and will soon have the ability to import from .PPL files, parsing the file and extracting all functions, procedures, classes, etc… You just then have to fill in the blanks.

Of course it is very early, the editor will be improved on in the following weeks.

Here is the PAsm component description XML data:

<help>
<name>PAsm</name>
<classname>PAsm</classname>
<filename>PAsm.html</filename>
<type>0</type>
<tags>assembler pasm call</tags>
<description>This component allows you to call PPL assembly code.</description>
<paramdescription>Code$ = Provide code to be executed as you create the object.</paramdescription>
<example>a$ = new PAsm;
a.Code = {
mov r0, 10
};
a.Execute;
a.Free;</example>
<seealso>PObject</seealso>
</help>

No comments yet.
You must be logged in to post a comment.
TOP