Date   

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

Marsh, Ed
 

Hi Eliot,
I was studying your first link yesterday :) Will check out the remainder tonight.
Ed.


Apply to join the DITA users group #admin

Bella Zhao
 

Hi,

 

I’m a technical writer in China and I’d like to join the DITA user group as it is now closed on yahoo. I’m very interested in DITA and want to learn more from this group. Can you grant me access so I can receive the emails?

 

Best regards,

Bella Zhao

Technical Writer

 

 


Re: Glossary in a table #glossary #PDF #Oxygen

Radu Coravu
 

Hi Matt,

You could use a custom CSS which would define the glossterm and the glossdef as cells. And the parent element would have display table row. Something like:

*[class~="glossentry/glossterm"],
*[class~="glossentry/glossdef"]{
display:table-cell !important;
}

*[class~="glossentry/glossentry"]{
display:table-row !important;
}

This should work with our latest nightly build of the Oxygen Chemistry publishing engine.
If you are using the PDF Chemistry engine from Oxygen 21.1 and this does not work for you, maybe you can try using some display:inline-block displays on the elements.

Regards,
Radu

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

On 1/28/2020 10:09 PM, Matt Lorenzi via Groups.Io wrote:
I am using Oxygen to create a PDF output from a ditamap.
I would like my *glossentry* and *glossterm* sit next to each other rather than stacked, which is the default <block> behaviour.
I've tried to modify the CSS, playing around with display, position, padding, etc. Nothing works as I would like, so I think the best solution is to create a two-column table.
I am guessing this is something that has to be done with. *XSLT*? I have found snippets of code that should work, but don't know if I have to create a new XSLT file, or if there is one I can ad this to.
I'm in a bit of a crunch, so don't have time to dig too deep right now.


Glossary in a table #glossary #PDF #Oxygen

Matt Lorenzi <mjlorenzi@...>
 

I am using Oxygen to create a PDF output from a ditamap.
I would like my glossentry and glossterm sit next to each other rather than stacked, which is the default <block> behaviour.
I've tried to modify the CSS, playing around with display, position, padding, etc. Nothing works as I would like, so I think the best solution is to create a two-column table.
I am guessing this is something that has to be done with. XSLT? I have found snippets of code that should work, but don't know if I have to create a new XSLT file, or if there is one I can ad this to.
I'm in a bit of a crunch, so don't have time to dig too deep right now.


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

Kristen James Eberlein
 

Hi, Jonathan.

We talked about your e-mail on today's DITA Technical Committee call. I am going to respond to one part of your question, and another TC member will address another.

So, why is the hazard statement domain included in the base package?

The base package was designed to include the most fundamental pieces of the DITA architecture:

  • Topic
  • Map
  • Subject scheme
  • The most basic domains: DITAVAL, hazard statement, highlighting, and utilities

Identified users for the package included marketing and medical information. We thought that the hazard statement domain would be necessary for medical information or marketing information about drugs or medical devices.

For more information about the three packages of DITA 1.3, see http://docs.oasis-open.org/dita/dita-1.3-why-three-editions/v1.0/dita-1.3-why-three-editions-v1.0.html

Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)

On 1/24/2020 3:00 PM, Jonathan Hanna wrote:
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: Keyref/conkey ref conversion strategy - keyref all the things? #conref

ekimber@contrext.com
 

If you can manage it, replacing all references from topics to other things (so conrefs, cross references, etc.) to use keys is the best way to go. Within maps it may or may not make sense to use keys, for example, from navigation topicrefs to separate resource-only keys for the topics, depending on your re-use patterns.

I've made a number of presentations over the years about using keys and you can find them all on SlideShare, including:

* https://www.slideshare.net/drmacro/ki-qi-key-the-way-of-dita-harmony-with-keys-and-key-references
* https://www.slideshare.net/drmacro/dita-reuse-challenges-and-response
* https://www.slideshare.net/drmacro/they-worked-before-what-happened-understanding-dita-crossbook-links

Cheers,

E.

--
Eliot Kimber
http://contrext.com


On 1/28/20, 9:18 AM, "Marsh, Ed" <dita-users@groups.io on behalf of Ed.Marsh@gs.com> wrote:

Thanks, Chris, this is exactly the discussion I'm looking for (though I wasn't quite looking for it then!).

We're moving from a bespoke DITA-to-Confluence system to a static site generator (Hugo). We have to refactor our links (and our file structure) and I'm hoping to take this opportunity to Keyref All The Things, just wasn't sure if this was the 'right' way to go.

I may be reaching out offline :)

I should also add a huge thanks to Radu who sent over an XSL solution.

Ed.


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

Marsh, Ed
 

Thanks, Chris, this is exactly the discussion I'm looking for (though I wasn't quite looking for it then!).

We're moving from a bespoke DITA-to-Confluence system to a static site generator (Hugo). We have to refactor our links (and our file structure) and I'm hoping to take this opportunity to Keyref All The Things, just wasn't sure if this was the 'right' way to go.

I may be reaching out offline :)

I should also add a huge thanks to Radu who sent over an XSL solution.

Ed.


Are you using the DITA 1.3 troubleshooting topic? #troubleshooting

Kristen James Eberlein
 

I'm curious; how many companies and implementations are using the DITA 1.3 troubleshooting topic?

The troubleshooting topic arrived with DITA 1.3; it was championed by the DITA Technical Communication subcommittee and much of the work was done by Bob Thomas, Tagsmiths.

There is an excellent white paper that Bob authored for the DITA Adoption TC: https://www.oasis-open.org/committees/download.php/53517/DITA13TroubleshootingArticle_FINAL_03jul14.pdf

Anyhow, who is using the troubleshooting topic? Are there things that work for you? Things that don't work for you?

For DITA 2.0 we (the DITA TC) are looking at the following enhancements:

  • A diagnostic element
  • Allowing <draft-comment> as an option child of <remedy>
--
Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)


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

1201 - 1220 of 46324