DeepBlueCLtd / Fi3ldMan

Field Service Manual with advanced data exploitation
https://deepbluecltd.github.io/Fi3ldMan/
Apache License 2.0
1 stars 1 forks source link

Procedure to insert linebreak #109

Closed IanMayo closed 4 months ago

IanMayo commented 4 months ago

Document authors frequently use line-breaks to format content.

An example of this is in table headers, where the authors wish the line break to occur in a specific place.

The DITA solution to this is the <?linebreak?> processing instruction. The DITA-OT html transform converts this PI into <br/>.

I'm used to doing this in Text mode in OxygenXML, but we need an easy way to do this in Author mode. I then need to document it in the FieldMan user guide.

It would be useful if we could register this snippet in OxygenXML, for easy insertion. One day we may choose to wrap that as a plugin, but for now the manual steps to do it would be fine.

frank-zimmermann commented 4 months ago

I was not able to push a branch, but I can describe it here.

You can navigate to the Preferences > Code Templates and create a new code template, like in the following screenshot: image

In my case, I also added a shortcut (Shift+Return).

After applying this (we can save this as a Project Option), the editor can now insert the <?linebreak?> PI by pressing Shift+Return, or, by pressing Ctrl+Space: image

When start typing "line...", the code snippet is also shown.

I think by documenting how to use the shortcut helps a lot.

IanMayo commented 4 months ago

This is great, thanks.