Customize footer

Post here questions and problems related to editing and publishing DITA content.
MWdal
Posts: 6
Joined: Thu Jun 09, 2022 2:49 pm

Customize footer

Post by MWdal »

I tried to add the path to an xhtml file with footer content in the parameter webhelp.fragment.footer in the transformation scenario, bit no success. I also tried adding it in a ccs file but no luck, the actual path text i shown in the footer. Then I read here in the forum that I need a certain plugin for the "customize footer" function to work. Is that correct? I suppose that all available plugins show up in Preferences > Plugins?
thanks, Mikael
marius
Posts: 11
Joined: Thu Mar 05, 2009 11:44 am

Re: Customize footer

Post by marius »

Hello,

You can customize the footer for the WebHelp output in two ways, as described in our user manual.

The simplest way to achieve this is to insert the HTML fragment directly in the transformation scenario dialog. For this, you need to set the webhelp.fragment.footer parameter to a small well-formed XHTML fragment. Or you can save the fragment as a new file and set its path in the webhelp.fragment.footer parameter value.

If you are using a publishing template to customize your WebHelp output, you should add the fragment or the path to the XHTML file in the descriptor file of the publishing template.

When only the file path appears in the footer of WebHelp output, usually there is an issue either with an incorrect file path set to the
webhelp.fragment.footer parameter or with the file content (it is not well-formed).

Regards,
Marius
Marius Ciolacu
Syncro Soft / Oxygen XML
MWdal
Posts: 6
Joined: Thu Jun 09, 2022 2:49 pm

Re: Customize footer

Post by MWdal »

Thanks Marius.
Ok so extra plugin needed for this?
To see if I'm on the right track, could you say if the attached example qualifies as a well-formed xhtml file?
xhtmlExample.png
xhtmlExample.png (42.93 KiB) Viewed 316 times
/Mikael
Attachments
image.png
image.png (42.93 KiB) Viewed 316 times
chrispitude
Posts: 529
Joined: Thu May 02, 2019 2:32 pm

Re: Customize footer

Post by chrispitude »

Hi MWdal,

"Well-formed" is actually a specific reference to having the opening and closing tags balance each other (among other things):

https://en.wikipedia.org/wiki/Well-form ... quirements

If you put your content in a file and open it with Oxygen, the Oxygen editor will validate the document for you to ensure it is well-formed. I think of XHTML as HTML that follows the XML well-formed rules.

The content you included is not well-formed XHTML because the <br> tag must close itself (<br/>) in XHTML, unlike in regular HTML.

You might want to attach your files as zipped text files, as we cannot open image files in an Oxygen editor to evaluate them.
chrispitude
Posts: 529
Joined: Thu May 02, 2019 2:32 pm

Re: Customize footer

Post by chrispitude »

Hi MWdal,

Actually, there is a better description of well-formed in Oxygen's WebHelp documentation here:

https://www.oxygenxml.com/doc/versions/ ... -html.html

including a description of how to use an enclosing <html> root element that is unwrapped when you need to insert a sequence of multiple elements.
MWdal
Posts: 6
Joined: Thu Jun 09, 2022 2:49 pm

Re: Customize footer

Post by MWdal »

Ok got it. I opened the xhtml file in Oxygen and fixed the errors it showed. I also moved it to the same folder as the css descriptor files and the templates. But still the footer only shows the text that is in the parameter value in the template file - the file name footer.xhtml in this case.
Unfortunately due to company restrictions I can't attach any files, but since oxygen validated the file it should be ok. Seems Im missing something..
chrispitude
Posts: 529
Joined: Thu May 02, 2019 2:32 pm

Re: Customize footer

Post by chrispitude »

Hi MWdal,

I already had a small testcase I've been experimenting with, so I reduced it to just implementing a footer:

footer_example.zip
(15.75 KiB) Downloaded 8 times

Just publish the deliverable in the "project.xml" file. (You can right-click it and choose Transform with from the context menu, or you can open it in the editor and use the transformation button in the toolbar.)

Note that the footer HTML contains two separate child elements, and the footer.css file applies some CSS flexbox properties to push them apart to the left and right sides.

If this testcase works for you, maybe you can successively modify it to yours (or yours to it) until you find the problematic setting.
MWdal
Posts: 6
Joined: Thu Jun 09, 2022 2:49 pm

Re: Customize footer

Post by MWdal »

With some trial and error I think I got it working now.
Thanks for the example!
/Mikael
Post Reply