[docbook] How ghelp link works?

[Artur Szymanski]

Hi,

Since I would like to contribute to improving and creating Ubuntu
Documentation (both English and my native language Polish), I've still
been learning DocBook, Bazaar and other issues (I'm also trying to
improve my English;-)).
Recently I've started to review help pages, trying to find errors,
incorrect links, etc. My last reviewed document was hardware.xml where I
found errors, made some corrections and put it to the patch that then I
included to bug report. Unfortunately my patch didn't fix all problems
with hardware.xml file, because some of them I could not (I don't know
how) resolve.

So, could somebody explain me how DocBook ghelp link works?

Hardware.xml file has reference to accessx-status.xml and looks like
"<ulink type='help' url='ghelp:accessx-status#index'>Keyboard
Accessibility Monitor</ulink>". It doesn't works when I click it. I
tried to replace index to other section id, but without success - when
I'm clicking the link I get "Unable load page" and "The requested URI
"ghelp:accessx-status#index is invalid" messages. I have
accessx-status.xml file, so I don't understand why URI is invalid?

I can't able to fix also next broken link:
"ghelp:gnome-access-guide#sysadmin-37". I made some invastigation and
found that the sysadmin entity in gnome-access-guide.xml is commented
out, hence the sysadmin.xml file is not included and section id
sysadmin-37 doesn't exist in the gnome-access-guide. I tried to reffered
directly to sysadmin.xml but I get the same error as above. Of course I
could comment out this link in our doc, but I found bug report related
to the broken link (#293842) and I don't know that I can do this.

Thanks in advance for your help.

Best Regards,
Artur