Date   

Cannot resolve keyrefs when creating PDFs from individual topics #keys

stinakab
 

Hi,

Has anybody created either a plug-in or a transformation in Oxygen that creates PDFs from individual topics where keyrefs to keys.ditamaps are resolved properly?
I know that there is a scenario in "Oxygen DITA PDF - based on HTML5 & CSS" that makes this possible, but we are still working with XSL- FO and cannot move to CSS right now.
I'm not sure if it's possible to just try and copy and adjust the basics of what has been done for the Oxygen scenario to make it work for XSL-FO as well.

Any help or ideas would be very welcome.

Thanks,
Christina


Re: Copying an internal link for a new browser, using a right-click. Is it possible?

Scott Barney
 

Thank you Marius - we are indeed using WebHelp Classic. We have some issues to solve before moving to WebHelp Responsive; however, this need may force the move.

 

Regards,


Scott

 

From: main@dita-users.groups.io <main@dita-users.groups.io> On Behalf Of Marius Ciolacu
Sent: Wednesday, May 5, 2021 10:43 PM
To: main@dita-users.groups.io
Subject: Re: [dita-users] Copying an internal link for a new browser, using a right-click. Is it possible?

 

Hello,

Following your instructions we were unable to reproduce the problem on a WebHelp Responsive output neither in the latest version of Oxygen nor in older versions.

However, if you are reproducing the problem on an WebHelp Classic output, please note that support for this was deprecated few years ago, and removed completely in the latest version of Oxygen/WebHelp.

If you want further help with this please provide more details about your used WebHelp version directly to our support email address (support@...).

 

Best regards,

Marius

--

Marius Ciolacu

Syncro Soft / Oxygen XML


Re: Copying an internal link for a new browser, using a right-click. Is it possible?

Marius Ciolacu
 

Hello,

Following your instructions we were unable to reproduce the problem on a WebHelp Responsive output neither in the latest version of Oxygen nor in older versions.

However, if you are reproducing the problem on an WebHelp Classic output, please note that support for this was deprecated few years ago, and removed completely in the latest version of Oxygen/WebHelp.

If you want further help with this please provide more details about your used WebHelp version directly to our support email address (support@...).

 

Best regards,

Marius

--

Marius Ciolacu

Syncro Soft / Oxygen XML


Publishing DITA content to knowledge bases

Radu Coravu
 

Hi,

I'm curious if there are any of you publishing DITA content to knowledge bases like for example Zendesk Guide, SalesForce, ServiceNow, Confluence or FreshDesk.

And how do you do that? Do you publish to HTML and then paste the content in the knowledge base? Or use a custom publishing plugin to accomplish that?

What are your challenges in doing that?

Regards,

Radu

Radu Coravu
Oxygen XML Editor


Re: SCORM output for DITA sources

MarkH
 

We use a highly customized WebHelp plugin to generate SCORM packages for our Moodle based training materials. Our training courses include Learning and Training specific elements such as learning overviews and quizzes. The plugin works very well, but it is a bit of a challenge to maintain and update. For instance, I am currently in the process of migrating from the version of the DITA-OT the plugin was originally developed in (1.8.4) to a newer version (3.5) so that we can take advantage of some of the improvements that have been made in the Open Toolkit.


Re: SCORM output for DITA sources

ekimber@contrext.com
 

It is possible to generate SCORM from DITA but there's no recently-modern open-source implementation exists as far as I know--there is a very simple DITA-to-SCORM plugin kicking around (I recently stumbled on a copy in one of my old archive drives when I was looking for something else) but I always have to dig for it when someone asks.

SCORM is very similar to its packaging and content to EPUB and if I was going to implement a SCORM generator today I would start with the DITA for Publishers EPUB transform as the base. There's also the issue that the SCORM components (schemas, etc.) are not licensed for redistribution so it's not legally allowed to have something like an OT plugin that includes the SCORM stuff out of the box, meaning you have manually get and combine the SCORM stuff. Very annoying.

The DITA Community project on GitHub has several plugins for rendering Learning and Training content statically (i.e., https://github.com/dita-community/org.dita.learning2.html) which could be useful as the basis for a new SCORM-generation transform.

One issue with SCORM is that you still have to tailor the output to the specific LMS system you're delivering with, since they have different styles and JavaScript libraries for interactive assessments, so there's only so far you can get with a generic SCORM generation transform.

Cheers,

Eliot

--
Eliot Kimber
http://contrext.com


On 5/3/21, 1:24 AM, "Prof. Sissi Closs" <main@dita-users.groups.io on behalf of closs@ctopic.de> wrote:

Dear DITA users,

Does anybody know a possibility to produce SCORM output from DITA sources (tagged with DITA learning).

Br, Sissi


Custom topic merge step for specific transtypes #DITA-OT

Nicolas Delobel
 

Hello,

I would like to override pdf2 topicMerge step, but for only some specific transtypes.
So first, I created a custom plugin using :
<feature extension="org.dita.pdf2.xsl.topicmerge" file="xsl/topicmergeImpl.xsl"/>

After that I would like to pass on, through a parameter, the current transtype to be used in XSLT. But I don't know how I can do that.

Someone has already faced this kind of problem?

Thanks.

Regards,
Nicolas


SCORM output for DITA sources

Prof. Sissi Closs
 

Dear DITA users,

 

Does anybody know a possibility to produce SCORM output from DITA sources (tagged with DITA learning).

 

Br, Sissi


Copying an internal link for a new browser, using a right-click. Is it possible?

Scott Barney
 

The issue:

Our support wants to be able to right-click on an internal link, and end up with a URL that can be pasted in a separate browser, to bring the reader to a specific section of the page.

The link is being created as a cross reference link in the DITA file:
 <xref href="r_fgl_errors_001.dita#r_fgl_errors_001/error-250"><msgnum>-250</msgnum></xref>

In our HTML output (DITA-OT and Oxygen WebHelp):
- If I click on the link, I am taken to the correct page, scrolled to the linked-to section. Which is to be expected, that it how it is designed to work.
- If I right-click and copy that link, then paste into another browser, it *flashes* to the right section -- but then the URL rewrites itself to be the URL of the page itself and I am taken to the top of the page.

For example, with the code above:
- The right-click pastes this link:
   https://intranet.xxx.com/distrib/manuals/FOURJS/FJSONLY/trunk/fjs-fgl-latest-manual-html-draft/fgl-topics/r_fgl_errors_001.html#r_fgl_errors_001__error-250

- After the paste, and the flash of where I want to be, the URL is rewritten to be:
  https://intranet.xxx.com/distrib/manuals/FOURJS/FJSONLY/trunk/fjs-fgl-latest-manual-html-draft/index.html#fgl-topics/r_fgl_errors_001.html 
  And we are taken to the top of the page.

Has anyone needed to solve this issue, and if so, how did you do it?


Markdown with abbreviated-form

Nicholas Mucks
 

Hi folks!

We’re looking at how to map some content models from dita to markdown. One of them is glossaries and inline references to the abbreviated-form element. We’d like to use markdown but still use glossary keys to get the surface form on first usage and the abbreviated form thereafter.

We like how the topic types work with the pandoc headers so that we can still get task labels and whatnot. Is pandoc usable to name the element as well, such as abbreviated-form with a key reference?

Has anyone done this?

Thanks!

Take care,
- Nick

Sent from mobile


Re: Can't link into conref? unstable ids

Stuart Norton
 

Thank you very much for pointing out the issue.

 

Somewhat surprisingly, I am not the same as the person who reported the problem there – good to know I'm not alone I guess. :-)

 

We will follow up further in GitHub.

 

Best regards,

Stuart

 

 

Juniper Business Use Only

From: main@dita-users.groups.io <main@dita-users.groups.io> On Behalf Of Radu Coravu
Sent: Wednesday, April 28, 2021 12:18 AM
To: main@dita-users.groups.io; dita-users@groups.io
Subject: Re: [dita-users] Can't link into conref? unstable ids

 

[External Email. Be cautious of content]

 

Hi Stuart,

About your questions:

  1. What if we overrode the id attribute generation to avoid the auto-generated unique values, and we occasionally had a duplicate id? Are there some dangers of having duplicate ids that I am missing – e.g. perhaps it could break the TOC?

From what I remember such problems do not break the publishing.

  1. Are there any other options that we have - other than reorganizing all of our content so we don't ever need to link to locations inside of conrefs?

I answered you here, I assume you added this issue to the DITA OT issues list:

https://github.com/dita-ot/dita-ot/issues/3736#issuecomment-828209386

Regards,

Radu

Radu Coravu
Oxygen XML Editor

On 4/28/21 00:50, Stuart Norton via groups.io wrote:

Dear DITA users,

 

We've discovered a behavior in DITA OT processing that looks like it's going to cause us big problems. We would really appreciate your advice.

 

The problem that we are seeing is that when we publish a document containing a conref (to HTML), the content inside that conref has its id attributes rewritten with more-or-less random values that can change unpredictably when the document is updated. For example:

id="request-system-reboot-command__d5358e39"

(the d### characters in bold are the ones that update randomly).

 

We have many external links that point into conrefed content. As a result of this behavior, those links are often breaking when we republish the documents.

 

It looks like this behavior is by design, and it happens in this step: https://www.dita-ot.org/dev/reference/preprocess-conref.html.  That step is intended to "ensure that the values of the id attribute within the referencing topic remain unique." But in our experience so far, I would say that the potential danger of having a duplicate id on an HTML page seem *much* more acceptable than having many external links break when we republish a document.

 

Questions:

  1. What if we overrode the id attribute generation to avoid the auto-generated unique values, and we occasionally had a duplicate id? Are there some dangers of having duplicate ids that I am missing – e.g. perhaps it could break the TOC?
  2. Are there any other options that we have - other than reorganizing all of our content so we don't ever need to link to locations inside of conrefs?

 

Thanks in advance for your thoughts/assistance.

 

Best regards,

Stuart

 

 

Juniper Business Use Only

 


Re: Can't link into conref? unstable ids

Radu Coravu
 

Hi Stuart,

About your questions:

  1. What if we overrode the id attribute generation to avoid the auto-generated unique values, and we occasionally had a duplicate id? Are there some dangers of having duplicate ids that I am missing – e.g. perhaps it could break the TOC?
From what I remember such problems do not break the publishing.
  1. Are there any other options that we have - other than reorganizing all of our content so we don't ever need to link to locations inside of conrefs?

I answered you here, I assume you added this issue to the DITA OT issues list:

https://github.com/dita-ot/dita-ot/issues/3736#issuecomment-828209386

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 4/28/21 00:50, Stuart Norton via groups.io wrote:

Dear DITA users,

 

We've discovered a behavior in DITA OT processing that looks like it's going to cause us big problems. We would really appreciate your advice.

 

The problem that we are seeing is that when we publish a document containing a conref (to HTML), the content inside that conref has its id attributes rewritten with more-or-less random values that can change unpredictably when the document is updated. For example:

id="request-system-reboot-command__d5358e39"

(the d### characters in bold are the ones that update randomly).

 

We have many external links that point into conrefed content. As a result of this behavior, those links are often breaking when we republish the documents.

 

It looks like this behavior is by design, and it happens in this step: https://www.dita-ot.org/dev/reference/preprocess-conref.html.  That step is intended to "ensure that the values of the id attribute within the referencing topic remain unique." But in our experience so far, I would say that the potential danger of having a duplicate id on an HTML page seem *much* more acceptable than having many external links break when we republish a document.

 

Questions:

  1. What if we overrode the id attribute generation to avoid the auto-generated unique values, and we occasionally had a duplicate id? Are there some dangers of having duplicate ids that I am missing – e.g. perhaps it could break the TOC?
  2. Are there any other options that we have - other than reorganizing all of our content so we don't ever need to link to locations inside of conrefs?

 

Thanks in advance for your thoughts/assistance.

 

Best regards,

Stuart

 


Juniper Business Use Only


  


Can't link into conref? unstable ids

Stuart Norton
 

Dear DITA users,

 

We've discovered a behavior in DITA OT processing that looks like it's going to cause us big problems. We would really appreciate your advice.

 

The problem that we are seeing is that when we publish a document containing a conref (to HTML), the content inside that conref has its id attributes rewritten with more-or-less random values that can change unpredictably when the document is updated. For example:

id="request-system-reboot-command__d5358e39"

(the d### characters in bold are the ones that update randomly).

 

We have many external links that point into conrefed content. As a result of this behavior, those links are often breaking when we republish the documents.

 

It looks like this behavior is by design, and it happens in this step: https://www.dita-ot.org/dev/reference/preprocess-conref.html.  That step is intended to "ensure that the values of the id attribute within the referencing topic remain unique." But in our experience so far, I would say that the potential danger of having a duplicate id on an HTML page seem *much* more acceptable than having many external links break when we republish a document.

 

Questions:

  1. What if we overrode the id attribute generation to avoid the auto-generated unique values, and we occasionally had a duplicate id? Are there some dangers of having duplicate ids that I am missing – e.g. perhaps it could break the TOC?
  2. Are there any other options that we have - other than reorganizing all of our content so we don't ever need to link to locations inside of conrefs?

 

Thanks in advance for your thoughts/assistance.

 

Best regards,

Stuart

 


Juniper Business Use Only


Re: Anyone using Oxygen XML Editor to generate WebHelp output from DITA content?

Radu Coravu
 

Thanks Leigh :)

On 4/27/21 17:18, Leigh White wrote:
Hi Radu,

The IXIASOFT online documentation is Oxygen WebHelp output with IXIASOFT styling. We love the ease of publishing. Here's one example:

https://www.ixiasoft.com/documentation/IXIASOFT_CCMS/6.3/User_Guides_Writer_DRM/en/index.html

Best,
Leigh
-- 
Radu Coravu
Oxygen XML Editor


Re: Anyone using Oxygen XML Editor to generate WebHelp output from DITA content?

Leigh White
 

Hi Radu,

The IXIASOFT online documentation is Oxygen WebHelp output with IXIASOFT styling. We love the ease of publishing. Here's one example:

https://www.ixiasoft.com/documentation/IXIASOFT_CCMS/6.3/User_Guides_Writer_DRM/en/index.html

Best,
Leigh


Re: Conditional Attribute Groups

Michael McLoughlin
 

Thanks for that Radu. You clearly have more fine-grained control with Subject Scheme maps.


Re: Conditional Attribute Groups

Radu Coravu
 

Hi Michael,

My take on this:

One thing better about using subject schemes to impose attribute values is that you automatically receive a validation error in Oxygen if you set the wrong value to an attribute, so the subject scheme controlled set of values is imposed when editing your content.

It's also beneficial I think to have the controlled values defined inside the DITA Project's content, so even if you do not use a special framework in Oxygen you get the same benefits from the controlled values.

Also Subject Scheme map defined values can influence the filtering stage when you publish:

https://www.oxygenxml.com/doc/versions/23.1/ug-editor/topics/subject-scheme-map.html#subject-scheme-map__using_a_subject_scheme_in_conjuction_with_a_ditav

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 4/27/21 10:53, Michael McLoughlin wrote:

Out of interest John, what's the benefit of using subject scheme maps in Oxygen over customizing the Oxygen cc_config,xml? We use the latter to control element, attribute and attribute value choice.

  


Re: Conditional Attribute Groups

Michael McLoughlin
 

Out of interest John, what's the benefit of using subject scheme maps in Oxygen over customizing the Oxygen cc_config,xml? We use the latter to control element, attribute and attribute value choice.


Re: Conditional Attribute Groups

john.kirkilis@...
 

The only thing I've done with subjectschemes is to demo a proof of concept to control valid values for conditional attributes. The subjectscheme maps can then be shared so all writers are honoring the same conditional processing logic for common cases, which is particularly relevant when content is reused across independent product repos using Git Submodules or other means. Oxygen uses the subjectscheme maps to control which values are presented in content completion popups and the Attributes view.

Besides DITA's provisions for filtering attributes for conditional content processing, have you also had the desire to filter by any of the topic metadata elements, such as category, featnum, or even othermeta? Has anyone added this capability to their own workflow, either in a pre or post processing phase to DITA-OT?

Metadata elements make their way into HTML output to allow the reader to filter or do faceted search at "browse time". It would seem natural to  allow a writer to have the option to do the same at build time to define specific deliverables.

Metadata elements have their own attributes. For example, <audience> has @type, @job, @experiencelevel, etc., which wouldn't quite fit the conditional attribute model. Without resorting to specialization, perhaps conditional attribute groups could be used to emulate these cases with @audience="job(operator) experiencelevel(advanced)". It would be possible to then use Schematron or the Oxygen SDK to keep the metadata elements and attribute groups in sync to some degree, where a change in one updates the other and any differences could be caught and quickfixes offered.

It could be handy if these currently orthogonal uses of "metadata" could be unified.


Re: Anyone using Oxygen XML Editor to generate WebHelp output from DITA content?

Radu Coravu
 

Hi Christina,

Thank you :)

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 4/24/21 13:19, stinakab via groups.io wrote:

Hi Radu,

You know ours already, but for the rest of the group: you're welcome to check out our latest public output layout on https://steinberg.help/nuendo/v11/en/index.html, made with Oxygen 23.0 and DITA OT 3.5.4, with accessibility in mind.
We have several layout versions of the webhelp output in our documents archive. The latest one is the one we are most proud of - for the moment. There are always new things to add.
We think the output gets better and better with every version. Thanks to the SyncRO Soft team.

Christina

  

1 - 20 of 46191