How does the htm GUI works

[MilitaoLucas]

Hello Florian, Dr. Oleg, how are you doing? I am doing an tree-sitter parser so I can have customized color highlighting in olex2 flavor of HTML (tree-sitter can also be used to do linting). I was able to understand the #include and #ifdef commands. But I am struggling with understanding how everything works. Is there any documentation on this? I couldn't find in the website.

That would help very much in developing the GUI for finishing up the OCC integration. Also, I think it would be helpful for other developers.

[MilitaoLucas]

The $ macros are a little confusing.

[pcxod]

Yes, it is been updated on regular basis but old and new features live in parallel...
$ followed by the function names (any of functions available in the Olex2 console) are evaluated as olex2 reads the htm files. Typically this is needed for 'standard' HTML tags that are parsed by wxWidgets (like table width if it depends on anything), Olex2 extensions, inc 'input', 'zimg', 'snippet', 'include' and 'ignore' will not require it in its attributes. However those functions can return a complete HTML fragment as well. Other pre-processor directives are '#include', '#includeif' and '#ignoreif'. The include directives create HTML 'switch' in the GUI, which state can be changed by the user clicking or using 'html.ItemState'.

For example the include below does produce something when INS or RES file is loaded and can have 3 states (0 - off, 1 for solution-button.htm and 2 for tool-off.htm with default being 0 - not rendered).

<!-- #includeif IsFileType('ires') g3-solve-solution-button gui\g3\solution-button.htm;gui\blocks\tool-off.htm;image=None;onclick=;0; -->

You can use templates with '#include' and pre-process them on the Python side using olex_gui.PreprocessHtml() which will process all of the Olex2 pre-processing extensions and create HTML to render by wxWidgets. The difference between Olex2 HTML tags and pre-processing tags is that tags (like 'include' and 'ignore') must produce complete HTML as they are parsed by the wxWidgets, with pre-processing you are more flexible....

if you need some conditional HTML block for loaded CIF, you can use:

<!-- #ignoreif not(IsFileType(cif)) -->
<p>CIF is loaded: $FileFull()</p> 
<!-- ignoreif# show this for CIF only -->

When dealing with dynamic tables - it should be done on the Python side...
Look at some small file that can give you an idea where to start, like this one:
http://svn.olex2.org/olex2-gui/trunk/etc/gui/geometry.htm

[MilitaoLucas]

That is extremely helpful. I will try and improve my tree-sitter grammar

[MilitaoLucas]

Question, is

<!-- #ignoreif not(IsFileType(cif))
html content
-->

In spec or out of spec? Because I based my parser in Nosphera2 files and I basically made it to be in the spec of the parser. I need to know which should be used because it is almost impossible to support both. Both seem to work in olex2

[MilitaoLucas]

I have this prototype for now.

[MilitaoLucas]

In this thread, I was trying to use a different file for my OCC GUI, and I am having some problems. Why doesn't this work:

<!-- #includeif not(strcmp(spy.getParam('snum.NoSpherA2.source'), "occ")) h3-NoSpherA2-Properties ..\util\pyUtil\NoSpherA2\h3-refine_NoSpherA2-Properties.htm;gui\blocks\tool-h3-off.htm;image=h3-NoSpherA2_Properties;onclick=;colspan=1;2; -->

while this works

<!-- #include h3-NoSpherA2-Properties ..\util\pyUtil\NoSpherA2\h3-refine_NoSpherA2-Properties.htm;gui\blocks\tool-h3-off.htm;image=h3-NoSpherA2_Properties;onclick=;colspan=1;2; -->

This seems very similar to something else I saw at the GUI code in report-metadata.htm:

<!-- #includeif not(strcmp(spy.getParam('snum.report.crystal_image'),"")) metadata-h3-crystal_image gui\h3-crystal_image.htm;gui\blocks\tool-h3-off.htm;image=h3-Crystal-Image;name=crystal_image;onclick=;colspan=1;2; -->

I get the following error:

: [/mnt/devel/svn/olex2/branches/1.5/sdl/macrolib.cpp(ProcessFunction):391]:
 N4esdl25TInvalidArgumentExceptionE problem with brackets at [/mnt/devel/svn/olex2/branches/1.5/sdl/exparse/exptree.cpp(expand_cmd):496]
	not(strcmp(spy.getParam('snum.NoSpherA2.source'),

I can't see what exactly I am doing wrong.

[pcxod]

You can always test this:

echo not(strcmp(spy.getParam('snum.NoSpherA2.source'), "occ"))

which seems to not cause problems So I would look at problems somewhere else - like why it does not print the whole line but just a bit of it - some white chars like new line?

[MilitaoLucas]

Thanks, I was just going to ask if there is a print function. This seems like a valid question. I have no idea. I will try to investigate a little more.

[MilitaoLucas]

Also, is there like a meta-comment? Like a comment that is just ignored so I can test other stuff?

[MilitaoLucas]

Ok, it seems like the space was the problem. Now I just have to figure out how to refresh the HTML on the change of this var.

[pcxod]

Question, is

<!-- #ignoreif not(IsFileType(cif))
html content
-->

In spec or out of spec? Because I based my parser in Nosphera2 files and I basically made it to be in the spec of the parser. I need to know which should be used because it is almost impossible to support both. Both seem to work in olex2

This is executed before the HTML parser, so the "html content" does not have to be balanced, if you have balanced HTML, you can use <ignore test=""></ignore> instead.

[MilitaoLucas]

This is executed before the HTML parser, so the "html content" does not have to be balanced, if you have balanced HTML, you can use <ignore test=""></ignore> instead.

Sorry if this is a stupid question. But what is balanced html?

[pcxod]

This is executed before the HTML parser, so the "html content" does not have to be balanced, if you have balanced HTML, you can use <ignore test=""></ignore> instead.

Sorry if this is a stupid question. But what is balanced html?

like all tags are complete.

[MilitaoLucas]

Ok. I guess I will try and support everything in my parser. At least I don't have to throw out my work until now.

[MilitaoLucas]

I was trying to do some stuff, and I was curious if it is possible to use JS in the htm files. It doesn't seem to be working for me. So I just want to know if it is supported.