Date   

Re: Publishing DITA content to knowledge bases

Thomas Rathkamp
 

There used to be a DITA-to-Confluence plugin years ago, but A) You needed the Confluence server to use it (where I was working at the time, we only had the Client) and B) I am not certain the plugin exists anymore. 



Tom Rathkamp
Senior Technical Writer




On Tuesday, May 11, 2021, 09:55:25 AM CDT, Grant Hogarth <grant.hogarth@...> wrote:


We were really interested in this (DITA -> Confluence) a year or so ago, but gave it up as too impractical to maintain, given the tools available.
Grant
Grant Hogarth 
Technical Writer, Services Tools team
Workiva Inc. 

On Mon, May 10, 2021 at 10:30 PM Radu Coravu <radu_coravu@...> wrote:

Hi Ozana,

Thanks for sharing this. The easiest approach I found to get DITA to Confluence was to produce a Word document from DITA and then import it in Confluence but probably a more specialized publishing plugin would be interesting too here.

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 5/10/21 16:53, Ozana Dragomir wrote:
Hi Radu,

We are not publishing DITA content to any such knowledge base, but some of our teams are interested in publishing to Confluence.

From my point of view, it would be worth it if we could also export from Confluence to DITA, but I am not aware of anyone doing that.

Thanks
Ozana

  


Re: Publishing DITA content to knowledge bases

 

We were really interested in this (DITA -> Confluence) a year or so ago, but gave it up as too impractical to maintain, given the tools available.
Grant
Grant Hogarth 
Technical Writer, Services Tools team
Workiva Inc. 

On Mon, May 10, 2021 at 10:30 PM Radu Coravu <radu_coravu@...> wrote:

Hi Ozana,

Thanks for sharing this. The easiest approach I found to get DITA to Confluence was to produce a Word document from DITA and then import it in Confluence but probably a more specialized publishing plugin would be interesting too here.

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 5/10/21 16:53, Ozana Dragomir wrote:
Hi Radu,

We are not publishing DITA content to any such knowledge base, but some of our teams are interested in publishing to Confluence.

From my point of view, it would be worth it if we could also export from Confluence to DITA, but I am not aware of anyone doing that.

Thanks
Ozana

  


Re: Publishing DITA content to knowledge bases

Radu Coravu
 

Hi Ozana,

Thanks for sharing this. The easiest approach I found to get DITA to Confluence was to produce a Word document from DITA and then import it in Confluence but probably a more specialized publishing plugin would be interesting too here.

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 5/10/21 16:53, Ozana Dragomir wrote:

Hi Radu,

We are not publishing DITA content to any such knowledge base, but some of our teams are interested in publishing to Confluence.

From my point of view, it would be worth it if we could also export from Confluence to DITA, but I am not aware of anyone doing that.

Thanks
Ozana

  


Re: Publishing DITA content to knowledge bases

Radu Coravu
 

Hi Pieterjan,

Thanks for sharing your usecase.

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 5/10/21 19:12, Pieterjan Vandenweghe wrote:

Hi Radu,

We use - amongst others - Xwiki as a knowledge base/collaborative intranet.
All the content from the DITA team is written in DITA and everything that doesn't relate to DITA, can quickly be created by adding new pages in Xwiki itself.

Workflow for the DITA content (stored in a GitHub repository):
  1. DITA topics are published with the default HTML5 DITA-OT plug-in to a dedicated folder in the GitHub repository.
  2. Import into Xwiki from the dedicated GitHub folder.
    During import the HTML5 topics are converted to the Xwiki standard (using Pandoc if I am not mistaken). It also imports metadata such as keyword, author...
So, no manual work after publishing from OxygenXML on our side besides clicking the import button in Xwiki (which could eventually also be automated).
Should you have further questions, don't hesitate to ask.

kind regards,
Pieterjan

On Mon, May 10, 2021 at 3:53 PM Ozana Dragomir <ozana.dragomir@...> wrote:
Hi Radu,

We are not publishing DITA content to any such knowledge base, but some of our teams are interested in publishing to Confluence.

From my point of view, it would be worth it if we could also export from Confluence to DITA, but I am not aware of anyone doing that.

Thanks
Ozana

  


Re: Publishing DITA content to knowledge bases

Pieterjan Vandenweghe
 

Hi Radu,

We use - amongst others - Xwiki as a knowledge base/collaborative intranet.
All the content from the DITA team is written in DITA and everything that doesn't relate to DITA, can quickly be created by adding new pages in Xwiki itself.

Workflow for the DITA content (stored in a GitHub repository):
  1. DITA topics are published with the default HTML5 DITA-OT plug-in to a dedicated folder in the GitHub repository.
  2. Import into Xwiki from the dedicated GitHub folder.
    During import the HTML5 topics are converted to the Xwiki standard (using Pandoc if I am not mistaken). It also imports metadata such as keyword, author...
So, no manual work after publishing from OxygenXML on our side besides clicking the import button in Xwiki (which could eventually also be automated).
Should you have further questions, don't hesitate to ask.

kind regards,
Pieterjan

On Mon, May 10, 2021 at 3:53 PM Ozana Dragomir <ozana.dragomir@...> wrote:
Hi Radu,

We are not publishing DITA content to any such knowledge base, but some of our teams are interested in publishing to Confluence.

From my point of view, it would be worth it if we could also export from Confluence to DITA, but I am not aware of anyone doing that.

Thanks
Ozana


Re: Publishing DITA content to knowledge bases

Ozana Dragomir
 

Hi Radu,

We are not publishing DITA content to any such knowledge base, but some of our teams are interested in publishing to Confluence.

From my point of view, it would be worth it if we could also export from Confluence to DITA, but I am not aware of anyone doing that.

Thanks
Ozana


Re: Cannot resolve keyrefs when creating PDFs from individual topics #keys

stinakab
 

Hi Nick,

Thanks for your reply.
Yes, I've tried that, but unfortunately, the keys are outside the root scope, because we share them among several projects. They are located higher in the hierarchy of files.
Any idea how to solve this?

Best rgds,
Christina


Re: Resources for a beginning technical writer (Was "Re: [dita-users] Publishing DITA content to knowledge bases")

DANIEL ESSIET
 

Thanks. I appreciate it.
Daniel Essiet.

On Sun, May 9, 2021, 2:02 PM Kristen James Eberlein <kris@...> wrote:

Hi, Daniel.

I want to point you to other resources for technical writing. (This list serv is narrowly focused on the use of DITA, the Darwin Information Typing Architecture.) The first resources that come to mind are the following:

  • Write the Docs Slack channel: https://writethedocs.slack.com/
    This is a friendly group of people; I'm sure that they will have many answers to your question.
  • Society for Technical Communication (STC): https://www.stc.org/
    This is the primary professional organization for technical writing in the US. They offer courses and Webinars; they also have chapters.
  • tekom: https://www.technical-communication.org/
    This is the primary professional organization for technical writing in Europe. They also offer courses and Webinars; they have more of an international presence than STC

Best of luck!

Best,
Kris

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


On 5/9/2021 5:39 AM, DANIEL ESSIET via groups.io wrote:
Which are  the best softwares for a beginning technical writer?
Thank you kindly.
Daniel Essiet
Lagos

On Sat, May 8, 2021, 10:08 PM Josh Honomichl <honomijr@...> wrote:
Hi Radu,

I'm currently working on a project to leverage our CMS-generated PDF outputs through the webspace in multiple ways, including knowlegebase delivery. The copy-paste route is a dead end as it's prohibitively expensive, doesn't scale, and extremely error-prone. We've found that the best option for achieving this end is to either engineer a custom OT plugin that you configure to push content into the pipeline, or invest in a tool that intakes DITA natively (ZoomIn, Ingenuix, etc). At this point, we are starting with the scripted deployments through a custom plugin, but the plan is to graduate to a purpose-built, enterprise-class deployment tool as soon as possible once we can prove our financial case.

The major challenges in the scripted deployment deal primarily with the limitations and requirements of the destination web CMS/tool. The creation of the custom JSON plugin is not really much of a problem. The most difficult part of us will likely be creation of the transactional API scripts as our destination tools are somewhat particular about how they import content.

Let me know if you have any questions.
josh


Re: Publishing DITA content to knowledge bases

Radu Coravu
 

Hi Josh,

Thanks for the details, any knowledge base tool (like Zendesk, Confluence) you are interested in particular? Or do you just want to have the flexibility to choose the delivery later on?

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 5/9/21 00:08, Josh Honomichl wrote:

Hi Radu,

I'm currently working on a project to leverage our CMS-generated PDF outputs through the webspace in multiple ways, including knowlegebase delivery. The copy-paste route is a dead end as it's prohibitively expensive, doesn't scale, and extremely error-prone. We've found that the best option for achieving this end is to either engineer a custom OT plugin that you configure to push content into the pipeline, or invest in a tool that intakes DITA natively (ZoomIn, Ingenuix, etc). At this point, we are starting with the scripted deployments through a custom plugin, but the plan is to graduate to a purpose-built, enterprise-class deployment tool as soon as possible once we can prove our financial case.

The major challenges in the scripted deployment deal primarily with the limitations and requirements of the destination web CMS/tool. The creation of the custom JSON plugin is not really much of a problem. The most difficult part of us will likely be creation of the transactional API scripts as our destination tools are somewhat particular about how they import content.

Let me know if you have any questions.
josh

  


Resources for a beginning technical writer (Was "Re: [dita-users] Publishing DITA content to knowledge bases")

Kristen James Eberlein
 

Hi, Daniel.

I want to point you to other resources for technical writing. (This list serv is narrowly focused on the use of DITA, the Darwin Information Typing Architecture.) The first resources that come to mind are the following:

  • Write the Docs Slack channel: https://writethedocs.slack.com/
    This is a friendly group of people; I'm sure that they will have many answers to your question.
  • Society for Technical Communication (STC): https://www.stc.org/
    This is the primary professional organization for technical writing in the US. They offer courses and Webinars; they also have chapters.
  • tekom: https://www.technical-communication.org/
    This is the primary professional organization for technical writing in Europe. They also offer courses and Webinars; they have more of an international presence than STC

Best of luck!

Best,
Kris

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


On 5/9/2021 5:39 AM, DANIEL ESSIET via groups.io wrote:
Which are  the best softwares for a beginning technical writer?
Thank you kindly.
Daniel Essiet
Lagos

On Sat, May 8, 2021, 10:08 PM Josh Honomichl <honomijr@...> wrote:
Hi Radu,

I'm currently working on a project to leverage our CMS-generated PDF outputs through the webspace in multiple ways, including knowlegebase delivery. The copy-paste route is a dead end as it's prohibitively expensive, doesn't scale, and extremely error-prone. We've found that the best option for achieving this end is to either engineer a custom OT plugin that you configure to push content into the pipeline, or invest in a tool that intakes DITA natively (ZoomIn, Ingenuix, etc). At this point, we are starting with the scripted deployments through a custom plugin, but the plan is to graduate to a purpose-built, enterprise-class deployment tool as soon as possible once we can prove our financial case.

The major challenges in the scripted deployment deal primarily with the limitations and requirements of the destination web CMS/tool. The creation of the custom JSON plugin is not really much of a problem. The most difficult part of us will likely be creation of the transactional API scripts as our destination tools are somewhat particular about how they import content.

Let me know if you have any questions.
josh


Re: Publishing DITA content to knowledge bases

DANIEL ESSIET
 

Which are  the best softwares for a beginning technical writer?
Thank you kindly.
Daniel Essiet
Lagos

On Sat, May 8, 2021, 10:08 PM Josh Honomichl <honomijr@...> wrote:
Hi Radu,

I'm currently working on a project to leverage our CMS-generated PDF outputs through the webspace in multiple ways, including knowlegebase delivery. The copy-paste route is a dead end as it's prohibitively expensive, doesn't scale, and extremely error-prone. We've found that the best option for achieving this end is to either engineer a custom OT plugin that you configure to push content into the pipeline, or invest in a tool that intakes DITA natively (ZoomIn, Ingenuix, etc). At this point, we are starting with the scripted deployments through a custom plugin, but the plan is to graduate to a purpose-built, enterprise-class deployment tool as soon as possible once we can prove our financial case.

The major challenges in the scripted deployment deal primarily with the limitations and requirements of the destination web CMS/tool. The creation of the custom JSON plugin is not really much of a problem. The most difficult part of us will likely be creation of the transactional API scripts as our destination tools are somewhat particular about how they import content.

Let me know if you have any questions.
josh


Re: Publishing DITA content to knowledge bases

Josh Honomichl
 

Hi Radu,

I'm currently working on a project to leverage our CMS-generated PDF outputs through the webspace in multiple ways, including knowlegebase delivery. The copy-paste route is a dead end as it's prohibitively expensive, doesn't scale, and extremely error-prone. We've found that the best option for achieving this end is to either engineer a custom OT plugin that you configure to push content into the pipeline, or invest in a tool that intakes DITA natively (ZoomIn, Ingenuix, etc). At this point, we are starting with the scripted deployments through a custom plugin, but the plan is to graduate to a purpose-built, enterprise-class deployment tool as soon as possible once we can prove our financial case.

The major challenges in the scripted deployment deal primarily with the limitations and requirements of the destination web CMS/tool. The creation of the custom JSON plugin is not really much of a problem. The most difficult part of us will likely be creation of the transactional API scripts as our destination tools are somewhat particular about how they import content.

Let me know if you have any questions.
josh


Re: Cannot resolve keyrefs when creating PDFs from individual topics #keys

Nicholas Mucks
 

Hi Christina,
Did you try specifying —resource and pointing to your keymap?

On May 7, 2021, at 7:00 AM, stinakab via groups.io <christina.kaboth@...> wrote:

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


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

121 - 140 of 46324