Cannot create Help inline page for Plugin

Development
1

Hi @dev_team

Following this (and I did it before for NS6.8) http://docs.nethserver.org/projects/nethserver-devel/en/v7b/inline_help.html I want to create a help page for the Panel Virtualhosts

I can see the files, but when I use the help page, my content is not displayed

-rw-r--r--  1 root root 2345 Sep  1 15:31 /usr/share/nethesis/NethServer/Help/en/NethServer_Module_VirtualHosts.html
-rw-r--r--  1 root root 1929 Oct 11  2016 /usr/share/nethesis/NethServer/Help/en/NethServer_Module_VirtualHosts_ModifyPlugin_PhpSettings.html
-rw-r--r--  1 root root 1284 Oct 11  2016 /usr/share/nethesis/NethServer/Help/en/NethServer_Module_VirtualHosts_ModifyPlugin_PhpSettings.rst
-rw-r--r--  1 root root 1384 Sep  1 15:30 /usr/share/nethesis/NethServer/Help/en/NethServer_Module_VirtualHosts.rst

This is the code I do in github https://github.com/stephdl/nethserver-phpsettings/tree/ns7/root/usr/share/nethesis/NethServer/Help/en

does something has changed, or I have my mistake in the front of my nose.

2 Likes
2

We must set an include statement inside the VirtualHost module help document…

3

I can find this in https://192.168.12.171:980/en-US/Help/Template/VirtualHosts.rst

{{{INCLUDE NethServer_Module_VirtualHosts_ModifyPlugin_*.rst}}}

Is this you are talking ?

1 Like
4

Yes it’s kinda glob pattern! Name your plugin after it, then it should be included automatically…

3 Likes
5

@giacomo @davidep do you have some pointers of the modification that I can commit to display the plugin help page please.

6

Looks good but the fileglob extension should be .html instead of .rst

7

where to commit then ?

8

The parent module is responsible for submodules inclusion

9

sorry I’m lost :slight_smile:

10

Ok my module is (quite ready) to be released…except for my issue. If I understand well the commit needs to be done on nethserver-VirtualHosts, but I didn’t see in which file. Hence my Interrogation.

11

got something

[root@NS7DEV2 ~]# grep -srni ' NethServer_Module_' /usr/share/nethesis/NethServer/
/usr/share/nethesis/NethServer/Help/en/NethServer_Module_Mail.html:18:{{{INCLUDE NethServer_Module_Mail_*.html}}}</div>
/usr/share/nethesis/NethServer/Help/en/NethServer_Module_Mail.rst:9:   {{{INCLUDE NethServer_Module_Mail_*.html}}}
1 Like
12

Thank you for your PR, @stephdl! It has been just merged! Please set the following as the first line in included files:

.. --initial-header-level=3

That preamble, shift up the HTML header levels, i.e. h1 to h3, h2 to h4 …

The merge is available from nethserver-testing repo:

  • nethserver-virtualhosts-1.0.1-1.2.gc3d5a7e.ns7.noarch.rpm
13

Installation without errors, see https://github.com/NethServer/nethserver-virtualhosts/pull/10

Now the help page is displayed for plugins

3 Likes
14

Thank you very much @stephdl, I recorded all this story as bug #5138.