Date   

Re: Template for DITA O-T HTML output #DITA-OT #HTML

Kevin Quinn
 

Cheers,

 

I have been trying to migrate from DITA 1.5.2 with heavily customized plugins to the latest version. Things have moved on in 10 years but making slow progress hopefully ensuring next migrations are simpler.

 

Regards,

Kevin

 

From: dita-users@groups.io <dita-users@groups.io> On Behalf Of Roger Sheen
Sent: 27 January 2020 16:21
To: dita-users@groups.io
Subject: Re: [dita-users] Template for DITA O-T HTML output #DITA-OT

 

On Monday, 2020-01-27, at 10:09 CET, Kevin Quinn wrote:

Does anyone know where I can get the template for the HTML that comes with the bundled DITA O-T help. I like the clean output and would like to re-use it as a template with some tweaks.

Hi Kevin,

You’ll find instructions for this use case in the DITA-OT documentation under
https://www.dita-ot.org/dev/topics/html-customization-css.html.

Everything you need is bundled in the default distribution package.

Hope that helps,

Roger


--

http://www.dita-ot.org/dev/ · DITA Open Toolkit Documentation


This message, including attachments, is CONFIDENTIAL. It may also be privileged or otherwise protected by law. If you received this email by mistake please let us know by reply and then delete it from your system; you should not copy it or disclose its contents to anyone. All messages sent to and from Enea may be monitored to ensure compliance with internal policies and to protect our business. Emails are not secure and cannot be guaranteed to be error free as they can be intercepted, a mended, lost or destroyed, or contain viruses. The sender therefore does not accept liability for any errors or omissions in the contents of this message, which arise as a result of email transmission. Anyone who communicates with us by email accepts these risks.


Re: Trouble using SVGs with Oxygen #PDF #SVG

Matt Lorenzi <mjlorenzi@...>
 

The Inkscape SVG issue is minor compared to other issues with Frame. I'm much happier in the Oxygen world.


Re: Is anyone using DITA's SVG domain without using the technical content package (i.e. concept/task/reference/troubleshooting)? #SVG

Briggs, John
 

Both SVG and MathML should have their own domains which should be add-ons. The rest of the domains should not be cluttered with these domains.

 

We do use SVG and MathML by reference, but in the 10 years or so that we have been using DITA, not a single writer has expressed the desire to author either SVG or MathML in DITA, especially when there are tools out there that make such authoring so much easier.

 

john briggs
Technical Documentation

 


Re: Template for DITA O-T HTML output #DITA-OT #HTML

Roger Sheen
 

On Monday, 2020-01-27, at 10:09 CET, Kevin Quinn wrote:

Does anyone know where I can get the template for the HTML that comes with the bundled DITA O-T help. I like the clean output and would like to re-use it as a template with some tweaks.

Hi Kevin,

You’ll find instructions for this use case in the DITA-OT documentation under
https://www.dita-ot.org/dev/topics/html-customization-css.html.

Everything you need is bundled in the default distribution package.

Hope that helps,

Roger


--

http://www.dita-ot.org/dev/ · DITA Open Toolkit Documentation


Re: Trouble using SVGs with Oxygen #PDF #SVG

Radu Coravu
 

Hi Matt,

Oxygen is using the Apache Batik SVG processing engine and probably Frame uses something else.

Regards,
Radu

Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com

On 1/23/2020 7:13 PM, Matt Lorenzi via Groups.Io wrote:
I think the SVG vendor you won't mention is the same "freeware" program used by our software team. The issue we are having is with <flowRoot> which was something developed for SVG 1.2 and never fully adopted/implemented. So this vendor played a bit loose in "supporting" a feature that was not yet ready. The solution for me is to not use this program to begin with, but short of that, don't use the <flowRoot> tag - which essentially allows text to flow within a text box.
I don't blame Oxygen for this one, however do find it funny that the ever-clunky Adobe FrameMaker was able to process these SVG files without issue. Perhaps they use a different SVG processing engine?


Re: Trouble using SVGs with Oxygen #PDF #SVG

Radu Coravu
 

Hi Matt,

In the Oxygen main menu "Find" there is a "Find/Replace in Files" action which you can use to search for content in all files in a certain path.

Regards,
Radu

Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com

On 1/24/2020 2:41 AM, Matt Lorenzi via Groups.Io wrote:
I get a fatal error message on publishing my Ditamap because the FOP encountered an element <flowRoot>. I went through all my topics looking for image error messages, but could find none. Not saying there is not an image in there somewhere that has <flowRoot> in it.
I don't think the build log will tell me exactly where it encountered the error. Not sure what is left for me to do other than open all of my SVG files in a text editor and search for <flowRoot>.
Damn Inkscape!


Template for DITA O-T HTML output #DITA-OT #HTML

Kevin Quinn
 

Hi,

 

Does anyone know where I can get the template for the HTML that comes with the bundled DITA O-T help. I like the clean output and would like to re-use it as a template with some tweaks.

 

Kevin

 

RGB Dark Blue Med (email sig)

 

Kevin Quinn

Principal Technical Writer

OWM Business Unit

Email: kevin.quinn@...

Phone: +44 7980797505

 

“Here’s what we do …”

 


This message, including attachments, is CONFIDENTIAL. It may also be privileged or otherwise protected by law. If you received this email by mistake please let us know by reply and then delete it from your system; you should not copy it or disclose its contents to anyone. All messages sent to and from Enea may be monitored to ensure compliance with internal policies and to protect our business. Emails are not secure and cannot be guaranteed to be error free as they can be intercepted, a mended, lost or destroyed, or contain viruses. The sender therefore does not accept liability for any errors or omissions in the contents of this message, which arise as a result of email transmission. Anyone who communicates with us by email accepts these risks.


Re: Is anyone using DITA's SVG domain without using the technical content package (i.e. concept/task/reference/troubleshooting)? #SVG

Jonathan Hanna
 

Hi Kris,

As mentioned previously, I am new to DITA, so please forgive the ignorance behind my questions and comments. 

Again, it seems odd that the SVG and MathML domains would not be included as part of the base package. Both SVG and MathML are commonly used with HTML. MS-Word comes with the ability to insert equations and markup images in documents by default and not as an add-on package. I would think that users would expect this to be part of the base DITA package as well. What is the rationale for not including these domains in the base package?

I also find it odd that the hazard statement domain would be included with the base package. The hazard statement domain seems like a natural fit for the technical content package, especially since they are specializations of notes. What is the rationale for including the hazard statement domain in the base package?

I know that these are discussions for technical committee meetings and I am not trying to start a debate. I am just a curious newbie :-).

Thanks,
Jonathan Hanna


Re: Adding "next topic", "previous topic" throughout an entire map? #HTML #linking

Chris Papademetrious
 

Hi Lief,

Indeed, I noticed that Oxygen's WebHelp seems to implement this in the desired way!

This morning I could not reproduce what I posted earlier. I suspect those results were for multiple collection sequences in the map, not just at the map level.

So I reran with collection-type="sequence" applied *only* at the map level. I found that the behavior differs between DITA-OT 3.4 and Oxygen's DITA-OT:

DITA-OT 3.4:

<map collection-type="sequence">
  <title>This Book</title>
  <topicref href="t1/topic0.dita">  >---+
    <topicref href="t1/topic1.dita"/>   |
    <topicref href="t1/topic2.dita"/>   |
    <topicref href="t1/topic3.dita"/>   |
  </topicref>                           |
                                        |
  <topicref href="t2/topic0.dita">  <---+  >--+
    <topicref href="t2/topic1.dita"/>         |
    <topicref href="t2/topic2.dita"/>         |
    <topicref href="t2/topic3.dita"/>         |
  </topicref>                                 |
                                              |
  <topicref href="t3/topic0.dita">  <---------+
    <topicref href="t3/topic1.dita"/>
    <topicref href="t3/topic2.dita"/>   
    <topicref href="t3/topic3.dita"/>
  </topicref>
</map>


Oxygen's DITA-OT:

<map collection-type="sequence">
  <title>This Book</title>
  <topicref href="t1/topic0.dita">  >-------+
    <topicref href="t1/topic1.dita"/>  <----+
    <topicref href="t1/topic2.dita"/>
    <topicref href="t1/topic3.dita"/>
  </topicref>
  <topicref href="t2/topic0.dita">  >-------+
    <topicref href="t2/topic1.dita"/>  <----+
    <topicref href="t2/topic2.dita"/>
    <topicref href="t2/topic3.dita"/>
  </topicref>
  <topicref href="t3/topic0.dita">  >-------+
    <topicref href="t3/topic1.dita"/>  <----+
    <topicref href="t3/topic2.dita"/>
    <topicref href="t3/topic3.dita"/>
  </topicref>
</map>


Both results used plain 'html5' transforms with fresh installations and no plugins installed. I'm not quite sure what to make of this difference. Which is correct and which is incorrect?

(Neither seems "correct" to me, because both provide the user with a "Next topic" link that skips information.)

 - Chris


Strings and Variables - which are used where? #DITA-OT #PDF #HTML

Vic Mortelmans
 

Hi,
I'm puzzled by the DITA-OT mechanism for generated text.

I find two repositories where (localized) generic text is stored. Based on examples, both seem to be retrievable using the "getVariable" XSL template.

1/ Strings
  • location: dita-ot-3.4\plugins\org.dita.base\xsl\common\strings-nl-nl.xml
  • entries look like: <str name="Caution">Let op!</str>
  • customizable by using the "dita.xsl.strings" extension point in plugin.xml
2/ Variables (common vars)
  • location: dita-ot-3.4\plugins\org.dita.pdf2\cfg\common\vars\nl.xml
  • entries look like: <variable id="Foot note">Voetnoot.</variable>
  • customizable only by adding a file to the "Customization" directory to my plugin and updating its catalog.xml
Because they belong to different plugins, I can guess that the "Strings" can be used in all output types, and the "Variables" only in PDF output.

I am making a plugin that will produce both PDF and HTML5.

Some questions:

  1. Are most of the above findings/assumptions correct? 
  2. When customizing generated text for my plugin, can I ignore the "Variables" alltogether and use only "Strings" as a repository for any of my custom text, that is retrieved using the "getVariable" template?
  3. There's also a file "commonvariables.xml" containing text that is not translated, how can I customize that in my plugin? 


Thanks for sharing some experience,
Best regards,

Vic


Re: Searching in files (was: Trouble using SVGs with Oxygen #images)

 

If you are on Windows, I *highly* recommend "Agent Ransack" or for more search/filter goodness, drop $40 on the pro version (FileLocator Pro), which allows you to search remote directories (among other things).
I have been a fan of these for years, they make life (and cleaning up files) much easier and less stressful.

Grant

On Fri, Jan 24, 2020 at 2:54 AM Wayne Brissette <wbrisett@...> wrote:


Matt Lorenzi via Groups.Io wrote on 2020-01-23 18:41:

I don't think the build log will tell me exactly where it encountered the error. Not sure what is left for me to do other than open all of my SVG files in a text editor and search for <flowRoot>. 

Just use grep. This is how I find errors in SVGs all the time. I also wonder if folks are saving out in the Inkscape SVG format or standard SVG format. We've encountered errors using their SVG format, but almost none using the standard SVG export from Inkscape.

-Wayne



--
Grant Hogarth 
Technical Writer, SA Tools
Workiva Inc. 
1700 Platte St, Suite 200, Denver, Colorado 80202 
Mobile: 1-801-815-8353 


Zendesk

Yves Barbion
 

Are there any DITA CCMS vendors in here who have a connector to Zendesk?

Kind regards

Yves Barbion


Re: Keyref/conkey ref conversion strategy - keyref all the things? #conref

Chris Papademetrious
 

Hi Ed,

I posted a similar question awhile back:


We are relatively new to DITA. Our writers have been adding cross-book links to their content (which is calling our bluff on finding a PDF/OLH solution to publish them properly!). As a result, we decided to use keyref cross-references for all topic references, both within-book and cross-book.

The easiest part has been the creation of the topic cross-references in Oxygen XML Author. Notably,

  • If you drag-and-drop a topic from the DITA Maps Manager into your editing window, Oxygen creates a keyref-based reference (if possible).
    • If the topic isn't reachable by keyref, Oxygen is smart enough to insert an href-based reference instead.
  • If you copy a topic (or other) element, then do a Paste Special > Paste as link (keyref), then Oxygen inserts a keyref-based reference to that element.
    • If the element isn't reachable by keyref, the tool issues an error dialog.
In both cases, Oxygen creates the scoped keyref properly if the reference is in another book's keyscope.

The hardest part has been getting writers to remember to create key values for new topics. If they don't, there's nothing to reference. I've filed an Oxygen enhancement request to automatically populate the key values of new topics, similar to how the topic filename and @id values are pre-set.

I wish there were a "Paste as link (keyref/href)" that would prefer keyrefs but fall back to hrefs. Then I would keep only that in the right-click context menu to guide writers to the best practice by construction.

 - Chris


Re: Is anyone using DITA's SVG domain without using the technical content package (i.e. concept/task/reference/troubleshooting)? #SVG

Chris Papademetrious
 

Hi Nancy,

We don't fit precisely in your category. We aren't using concept, task, reference, but we are using bookmap.

We don't use the svgDomain, but we do use SVG images as @href targets of images.

Now that I think about it, I'm not sure what the svgDomain is used for...

 - Chris

 


Re: Image placement: inline or break (with align= "center") #CSS #images

Chris Papademetrious
 

Hi Matt,

For keeping titles with their content, I prefer to enforce this with CSS because it's something you want to be a fixed characteristic of the output, not configurable by the user.

 - Chris


Re: Trouble using SVGs with Oxygen #PDF #SVG

Wayne Brissette
 



Matt Lorenzi via Groups.Io wrote on 2020-01-23 18:41:

I don't think the build log will tell me exactly where it encountered the error. Not sure what is left for me to do other than open all of my SVG files in a text editor and search for <flowRoot>. 

Just use grep. This is how I find errors in SVGs all the time. I also wonder if folks are saving out in the Inkscape SVG format or standard SVG format. We've encountered errors using their SVG format, but almost none using the standard SVG export from Inkscape.

-Wayne


Re: Trouble using SVGs with Oxygen #PDF #SVG

Matt Lorenzi <mjlorenzi@...>
 

I get a fatal error message on publishing my Ditamap because the FOP encountered an element <flowRoot>. I went through all my topics looking for image error messages, but could find none. Not saying there is not an image in there somewhere that has <flowRoot> in it.

I don't think the build log will tell me exactly where it encountered the error. Not sure what is left for me to do other than open all of my SVG files in a text editor and search for <flowRoot>. 

Damn Inkscape!


Re: Image placement: inline or break (with align= "center") #CSS #images

Matt Lorenzi <mjlorenzi@...>
 

With regards to images and page breaks, obviously I want my figure title to always sit on to of the image, and never break (image title on one page, image on another). Again, easy enough with attribute outputclass="page-break-avoid", but would have to make sure I assign this to all images? If I wanted to to this globally for all images, would I be best to use CSS?


Re: Trouble using SVGs with Oxygen #PDF #SVG

Wayne Brissette
 

Matt Lorenzi via Groups.Io wrote on 2020-01-23 11:13:
I think the SVG vendor you won't mention is the same "freeware" program used by our software team. The issue we are having is with <flowRoot> which was something developed for SVG 1.2 and never fully adopted/implemented. So this vendor played a bit loose in "supporting" a feature that was not yet ready. The solution for me is to not use this program to begin with, but short of that, don't use the <flowRoot> tag - which essentially allows text to flow within a text box.
Actually, No... But you've highlighted the biggest SVG challenge. Every vendor does things differently.

-Wayne


Re: Trouble using SVGs with Oxygen #PDF #SVG

Matt Lorenzi <mjlorenzi@...>
 

I think the SVG vendor you won't mention is the same "freeware" program used by our software team. The issue we are having is with <flowRoot> which was something developed for SVG 1.2 and never fully adopted/implemented. So this vendor played a bit loose in "supporting" a feature that was not yet ready. The solution for me is to not use this program to begin with, but short of that, don't use the <flowRoot> tag - which essentially allows text to flow within a text box. 

I don't blame Oxygen for this one, however do find it funny that the ever-clunky Adobe FrameMaker was able to process these SVG files without issue. Perhaps they use a different SVG processing engine?

1161 - 1180 of 46276