Date   

Re: Using Lightweight DITA's HTML5 format? #HTML5 #LwDITA

Mark Giffin
 

Hi Mica,

Your observation is correct. There are not a lot of details and examples available about the HTML5 format of Lightweight DITA (HDITA), outside of the committee note on it. I'm on the LWDITA subcommittee and there is no DTD or other schema for HDITA. I think that was largely because it was hard to figure out what to use for it. There is no DTD for HTML5 itself, because they have officially cut ties with SGML (which is where DTDs came from).

Oxygen has good support for MDITA and XDITA (some other tools do also), but not much (none?) for HDITA. In my personal experience, most of the interest is in Markdown/MDITA.

HDITA is basically standard HTML5. It does not violate the HTML5 specs. There is a validator for HTML5:

https://about.validator.nu/
https://github.com/validator/validator/wiki/Service-%C2%BB-HTTP-interface

I think that Oxygen now implements this validator but I have not tested it yet. But that doesn't help you validate HDITA.

By the way, there is also no official validation mechanism for the Markdown format of Lightweight DITA (MDITA). Although the Oxygen Markdown editor may help with this, I'm not certain. And there's no official way to validate ordinary non-LWDITA Markdown either (and there are many flavors of it). I believe most people use their static site generator to "validate" their markdown content. But some people are trying on this.

Mark Giffin
Mark Giffin Consulting, Inc.
http://markgiffin.com/

On 2/6/2020 9:37 AM, Mica Semrick wrote:
I've been looking at migrating the docs for one of my favorite photo editing applications from docbook to something else. I had thought that HDITA would be a great fit for this content, but I can't seem to find much on the format, other than the examples in the spec. I can't create an HDITA topic in Oxygen, I can't find a DTD. Forgive my ignorance, but can someone shed some light on this?

Best,
Mica


Re: Using Lightweight DITA's HTML5 format? #HTML5 #LwDITA

Kristen James Eberlein
 

Hi, Mica.

Have you looked at the "Lightweight DITA: An Introduction" committee note? See http://docs.oasis-open.org/dita/LwDITA/v1.0/LwDITA-v1.0.html

No Lightweight DITA spec as yet (and maybe not for a LONG time).

oXygen DOES ship with the DTDs for the XDITA topic and map ...
-- 
Best,
Kris

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


Using Lightweight DITA's HTML5 format? #HTML5 #LwDITA

Mica Semrick
 

I've been looking at migrating the docs for one of my favorite photo editing applications from docbook to something else. I had thought that HDITA would be a great fit for this content, but I can't seem to find much on the format, other than the examples in the spec. I can't create an HDITA topic in Oxygen, I can't find a DTD. Forgive my ignorance, but can someone shed some light on this?

Best,
Mica


Re: unknown fo:block in a shortdesc in a link #PDF #shortdesc

Zoë Lawson
 

That helped.

I was able to get the formatting to display correctly by setting margin-left to inherit for topic__shortdesc.
Then when I style link__shortdesc, the margin is inherited.

Unfortunately this means there’s an fo warning because the topic shortdesc doesn’t have a margin to inherit...but at least it looks right.

I’m going to take the partial victory.

Thanks!
Zoë

Zoë Lawson


From: main@dita-users.groups.io <main@dita-users.groups.io> on behalf of Kristen James Eberlein <kris@...>
Sent: Thursday, February 6, 2020 7:10:55 AM
To: dita-users@groups.io <dita-users@groups.io>
Subject: Re: [dita-users] unknown fo:block in a shortdesc in a link
 

Hi, Zoe.


There's definitely some issues with styling short descriptions as displayed in related links. I ran into this last summer, when I spent several hours (without success) in trying to style them for the OASIS PDFs. I'll see if I can dig out my notes.


Leigh White, in the 2nd edition of her book, comments on page 430 that the attribute set link __shortdesc (in links-attr.xsl, called from links.xsl) "does not work out of the box; specifications for the shortdesc attribute set in commons-attr.xsl override this attribute set."


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/30/2020 12:50 PM, Zoë Lawson wrote:
I am working on an fop PDF from DITA-OT 3.3.1.
I am including child links in the content, and have the shortdesc displaying.

There's some additional block inside of the link__shortdesc block that is mucking with my formatting, and I can't figure out what it is.

Anyone have a guess?

Thanks,
Zoë


Re: unknown fo:block in a shortdesc in a link #PDF #shortdesc

Kristen James Eberlein
 

Hi, Zoe.


There's definitely some issues with styling short descriptions as displayed in related links. I ran into this last summer, when I spent several hours (without success) in trying to style them for the OASIS PDFs. I'll see if I can dig out my notes.


Leigh White, in the 2nd edition of her book, comments on page 430 that the attribute set link __shortdesc (in links-attr.xsl, called from links.xsl) "does not work out of the box; specifications for the shortdesc attribute set in commons-attr.xsl override this attribute set."


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/30/2020 12:50 PM, Zoë Lawson wrote:
I am working on an fop PDF from DITA-OT 3.3.1.
I am including child links in the content, and have the shortdesc displaying.

There's some additional block inside of the link__shortdesc block that is mucking with my formatting, and I can't figure out what it is.

Anyone have a guess?

Thanks,
Zoë


Re: Pulling Bookmeta data into PDF footer #CSS #Oxygen #PDF

Radu Coravu
 

Hi Chris,

It would be great if you could contribute topics to the Oxygen XML Blog.
Some details about how you can contribute can be found here:

https://oxygenxmlblog.netlify.com/topics/welcome.html#welcome__section_tnr_rr3_jkb

I think you can contribute only the topic with your author name and creation date specified in the prolog and we'll try to find a place for it in the DITA Map, maybe make a category called "Guest Posts".

Regards,
Radu

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

On 2/5/2020 3:53 PM, Chris Papademetrious wrote:
Hi Matt,
I had a similar question here:
https://www.oxygenxml.com/forum/post55680.html
with answer provided here:
https://www.oxygenxml.com/forum/post55679.html
We originally stored our book information, including release information, in <bookmeta>. However, the metadata was getting duplicated many times in the intermediate files, which made it painful to look through the HTML for adjusting CSS, etc.
We've since moved to storing our release information in a *shared key definition file*:
<?xml version="1.0" encoding="utf-8"?>
<?xml-model href="urn:oasis:names:tc:dita:rng:map.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
<map>
  <keydef keys="Release">
    <topicmeta>
      <keywords>
        <keyword>Q-2019.12</keyword>
      </keywords>
    </topicmeta>
  </keydef>
  <keydef keys="Date">
    <topicmeta>
      <keywords>
        <keyword>December 2019</keyword>
      </keywords>
    </topicmeta>
  </keydef>
</map>
We then mapref this from all of our books in this collection. Changing the file updates all the books.
The trick to this (provided by SyncroSoft in the second link above) is that an *unreferenced* key's value is not present in the HTML file to grab from the CSS. To remedy this, just add <data> bookmeta entries that reference these keys to your book:
<?xml version="1.0" encoding="utf-8"?>
<?xml-model href="urn:oasis:names:tc:dita:rng:bookmap.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
<bookmap>
  <title>Fusion Compiler™ Design-for-Test User Guide</title>
<bookmeta>
    <data keyref="Release"/>
    <data keyref="Date"/>
  </bookmeta>
  <frontmatter>
<mapref href="synthesis/release_vars.ditamap"/>
These are copied to the merged HTML as nonprinting metadata elements (only once!!):
<div keyref="Release" class="- topic/data data">
  <div class="- topic/keyword keyword">Q-2019.12</div>
</div>
<div keyref="Date" class="- topic/data data">
  <div class="- topic/keyword keyword">December 2019</div>
</div>
which you can then reference from your CSS:
@page {
    @bottom-left {
      content: string(maptitle) "\a" oxy_xpath('//div[contains(@class, " bookmap/bookmeta ")]/div[@keyref = "Release"]//text()');
    }
}
 - Chris
(Radu - should I contribute this as a blog post to your Git blog repo?)


Re: Fw: DITA-OT compile error #DITA-OT

scott ashmead
 

-v identified the problem. Thank you!

On Wednesday, February 5, 2020, 12:14:00 AM EST, Radu Coravu <radu_coravu@...> wrote:


Hi Scott,

Maybe you can also pass the "-v" flag to the "dita" command to see some
more console output before the failure, it may include information about
what XSLT stylesheet was last processed.

Regards,
Radu

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

On 2/4/2020 11:51 PM, scott ashmead via Groups.Io wrote:
>
> Hi users!
>
> I'm attempting to use DITA-OT using this command:
>
> dita -input Renewal_Change_Form_MC.dita
> -format dita
> -output props\
> -args.filter=RCF.ditaval
>
> I'm getting this error:
> Error: javax.xml.transform.TransformerConfigurationException: Failed to
> compile stylesheet. 1 error detected.
>
> There's aproximately 12,000 lines of code in the XSLT transform. Any
> suggestions for identifying where the compile error is? Oxygen doesn't
> identify anything in the XSLT as being problematic.
>
> Is this perhaps a compiler version problem?
>
> Thank you,
> Scott Ashmead

>






Re: Pulling Bookmeta data into PDF footer #CSS #Oxygen #PDF

Chris Papademetrious
 

Hi Matt,

I had a similar question here:

https://www.oxygenxml.com/forum/post55680.html

with answer provided here:

https://www.oxygenxml.com/forum/post55679.html

We originally stored our book information, including release information, in <bookmeta>. However, the metadata was getting duplicated many times in the intermediate files, which made it painful to look through the HTML for adjusting CSS, etc.

We've since moved to storing our release information in a shared key definition file:

<?xml version="1.0" encoding="utf-8"?>
<?xml-model href="urn:oasis:names:tc:dita:rng:map.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
<map>
  <keydef keys="Release">
    <topicmeta>
      <keywords>
        <keyword>Q-2019.12</keyword>
      </keywords>
    </topicmeta>
  </keydef>
  <keydef keys="Date">
    <topicmeta>
      <keywords>
        <keyword>December 2019</keyword>
      </keywords>
    </topicmeta>
  </keydef>
</map>

We then mapref this from all of our books in this collection. Changing the file updates all the books.

The trick to this (provided by SyncroSoft in the second link above) is that an unreferenced key's value is not present in the HTML file to grab from the CSS. To remedy this, just add <data> bookmeta entries that reference these keys to your book:

<?xml version="1.0" encoding="utf-8"?>
<?xml-model href="urn:oasis:names:tc:dita:rng:bookmap.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
<bookmap>
  <title>Fusion Compiler™ Design-for-Test User Guide</title>
  <bookmeta>
    <data keyref="Release"/>
    <data keyref="Date"/>
  </bookmeta>
  <frontmatter>
    <mapref href="synthesis/release_vars.ditamap"/>

These are copied to the merged HTML as nonprinting metadata elements (only once!!):

<div keyref="Release" class="- topic/data data">
  <div class="- topic/keyword keyword">Q-2019.12</div>
</div>
<div keyref="Date" class="- topic/data data">
  <div class="- topic/keyword keyword">December 2019</div>
</div>

which you can then reference from your CSS:

@page {
    @bottom-left {
      content: string(maptitle) "\a" oxy_xpath('//div[contains(@class, " bookmap/bookmeta ")]/div[@keyref = "Release"]//text()');
    }
}

 - Chris

(Radu - should I contribute this as a blog post to your Git blog repo?)


Re: Pulling Bookmeta data into PDF footer #CSS #Oxygen #PDF

Radu Coravu
 

Hi Matt,

I think you will need to use an xpath expression in the CSS "content" property:

https://www.oxygenxml.com/doc/ug-editor/topics/dcpp_how_to_use_in_headers_text_extracted_from_the_document__xpath.html

You first need to get your hands on the merged HTML document from which the PDF will be created:

https://www.oxygenxml.com/doc/ug-editor/topics/dcpp_debugging_the_css.html

and practice your xpath expression on it using the Oxygen XPath toolbar.
The xpath expression you may end up using might be very simple, something like:

(//prognum)[1]/text()

meaning "find any "prognum" in the document, retrieve the first one and get all the text from it.

Regards,
Radu

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

On 2/5/2020 2:07 AM, Matt Lorenzi via Groups.Io wrote:
Upon further reading - would I be better using a keyref for my document number and that have placed in my footer using the CSS content property?


Re: Fw: DITA-OT compile error #DITA-OT

Radu Coravu
 

Hi Scott,

Maybe you can also pass the "-v" flag to the "dita" command to see some more console output before the failure, it may include information about what XSLT stylesheet was last processed.

Regards,
Radu

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

On 2/4/2020 11:51 PM, scott ashmead via Groups.Io wrote:
Hi users!
I'm attempting to use DITA-OT using this command:
dita -input Renewal_Change_Form_MC.dita
-format dita
-output props\
-args.filter=RCF.ditaval
I'm getting this error:
Error: javax.xml.transform.TransformerConfigurationException: Failed to compile stylesheet. 1 error detected.
There's aproximately 12,000 lines of code in the XSLT transform. Any suggestions for identifying where the compile error is? Oxygen doesn't identify anything in the XSLT as being problematic.
Is this perhaps a compiler version problem?
Thank you,
Scott Ashmead


Re: Pulling Bookmeta data into PDF footer #CSS #Oxygen #PDF

Matt Lorenzi <mjlorenzi@...>
 

Upon further reading - would I be better using a keyref for my document number and that have placed in my footer using the CSS content property?


Fw: DITA-OT compile error #DITA-OT

scott ashmead
 


Hi users!

I'm attempting to use DITA-OT using this command:

dita -input Renewal_Change_Form_MC.dita 
-format dita 
-output props\ 
-args.filter=RCF.ditaval

I'm getting this error:
Error: javax.xml.transform.TransformerConfigurationException: Failed to compile stylesheet. 1 error detected.

There's aproximately 12,000 lines of code in the XSLT transform. Any suggestions for identifying where the compile error is? Oxygen doesn't identify anything in the XSLT as being problematic.

Is this perhaps a compiler version problem?

Thank you,
Scott Ashmead


Pulling Bookmeta data into PDF footer #CSS #Oxygen #PDF

Matt Lorenzi <mjlorenzi@...>
 

I think my original post did not get published, or got lost.

I would like to pull a metadata entry into my footer, specifically from a tag called <prognum>

I don't know if I need to create a string-set first to define this variable, then use the CSS content property to call up the value.

I have found on thread on this subject in the Oxygen forums. Found here: https://www.oxygenxml.com/forum/post54911.html#p54911
I sense I may have to make use of XPath -  which scares me. 

Is what I am asking doable?

 


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

Chris Papademetrious
 

Hi Ed, all,

Our writers use nested <topic> elements in some topic files to keep tightly-related content together. One pain point with "keyref-all-the-things" is that subtopics nested within topic files also require key definitions to reference them or their contents:

      <topicref href="fcdm/preface/about_this_user_guide.dita" keys="about_this_user_guide">
        <topicref href="fcdm/preface/about_this_user_guide.dita#section_id1" keys="audience"/>
        <topicref href="fcdm/preface/about_this_user_guide.dita#section_id2" keys="related_publications"/>
        <topicref href="fcdm/preface/about_this_user_guide.dita#section_id3" keys="release_notes"/>
        <topicref href="fcdm/preface/about_this_user_guide.dita#section_id4" keys="conventions"/>
      </topicref>

It's impractical for authors to keep their map up-to-date as they create and modify subtopic structure and content. We have a "map-fixer" utility, written in perl and compiled to a Windows .exe with Strawberry Perl, that is configured as an external tool in Oxygen. Users can run this "Map Updater" utility from the menu and it will scan their DITA files and update their bookmap as needed. (It also populates the text content of cross-book <xref keyref> elements with the target text.)

The utility has a couple specific references to our directory structure and specializations, but I can point those areas out. This whole approach is admittedly a quick-and-dirty hack to keep our writers writing, I'm happy to share it if anyone's interested.

 - Chris


Re: Conditional table columns? #conditional-processing #tables

Julio J Vazquez
 

As far as I know, to remove a column, you'd have to conditionalize the corresponding colspec and each entry element in the column. It's far easier to replicate the table with the relevant column removed and conditionalize the table. 

Julio J. Vazquez


Re: Repeating table titles for tables that break on PDF output - Oxygen DITA #tables #CSS #PDF

David Yin
 

We have done what Eliot explains. We put the title in the header when we want it to repeat.


Conditional table columns? #conditional-processing #tables

Larry Kollar
 

One of the other writers asked if there was a way to conditionalize a table column. We tried setting @colwidth="0" but that just displayed the content in the margin outside the table. Has anyone ever had to do this?

I think it could be handled in the plugin, throwing away cells whose column width is zero. I'm in the middle of updating our plugins when I get a break from content work (until we hire a software person to handle the XSL stuff), so it might be a while before I could actually do anything with this.


Re: DITA O-T HTML5 Transform #DITA-OT #HTML

Mica Semrick
 

Hey Kevin,

You don't get an index.HTML with the default HTML5 transform. For the topic you want to be the index.HTML file, use a copy-to="index" attribute on the topicref.

-m


On January 31, 2020 6:52:22 AM PST, Kevin Quinn <kevin.quinn@...> wrote:

Hi,

 

I am experimenting around with the HTML5 transform but I am unable to get a index.html generated. I get the toc successfully however no index.html.

 

I am thinking and hopefully someone can clarify as my source is a bookmap I will not get the generated index.html. If my source is a ditamap it would work OK – is that correct ?

 

Guess I could manually create an index.html that reflect the contents and copy that in the correct folder as part of running the ANT target.

 

Kevin

 

 

 

 

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.


DITA O-T HTML5 Transform #DITA-OT #HTML

Kevin Quinn
 

Hi,

 

I am experimenting around with the HTML5 transform but I am unable to get a index.html generated. I get the toc successfully however no index.html.

 

I am thinking and hopefully someone can clarify as my source is a bookmap I will not get the generated index.html. If my source is a ditamap it would work OK – is that correct ?

 

Guess I could manually create an index.html that reflect the contents and copy that in the correct folder as part of running the ANT target.

 

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.


Call for participation for Balisage 2020 #conferences

Kristen James Eberlein
 

The call for participation in Balisage: The Markup Conference 2020 is open. See https://www.balisage.net/Call4Participation.html

The preconference symposium looks quite interesting: The Role of XML in Publishing Accessible Documents.

--
Best,
Kris

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

1061 - 1080 of 46224