Date   
[ann][virtual] Why #content practitioners should care about #research and journals | 8 July 2020 @ 15:00 UTC

Liz Fraley
 

Wednesday, 8 July 2020  @ 15:45 UTC
( 8:45am Los Angeles | 11:45am New York | 3:45pm London | 8:15pm Bangalore )

Register: https://bit.ly/room42-01


Why should practitioners care about research and journals?

Ah, that’s the question, isn’t it? We're looking forward to exploring it with you in Room 42.

Room 42 takes the best of webinars, podcasting, and online teaching for a virtual experience that is more interactive and more inclusive. It's designed to bring practitioners together with academics to share knowledge about new and ongoing communication research in an approachable, accessible way so practitioners can make micro-improvements to their content.

In our debut session, George Hayhoe, Professor emeritus of Mercer University School of Engineering, Editor-in-Chief, IEEE Transactions on Professional Communication, STC Fellow, and IEEE Life Fellow, will be in the room.

George says that there are three things—professional practice, teaching, and journal editorship—that, when considered together, have significantly informed his approach to the role of the technical communicator.

He will explore the reasons why practitioners should care about research and journals and tell you how the collaboration between both sides serves our entire profession.


Register: https://bit.ly/room42-01

-:-

Room 42 sessions are recorded before a live studio audience. You can ask questions in advance (when you register) or during the discussion.

Re: Relationships on Multiple Axes? #reltable

Ron Wheeler
 

I am not sure that I understand both your problems fully but free advice occasionally is worth more than the cost.

I think that reltables can do what you want but I would start with a test of 10 entries to see if it does before you do all 4K+
(Use keyrefs - see below)

Keys are the way to avoid hardcoding links.
Every topic gets a key that says where it is located on the disk.
References to the topic use key as the link.
Keys are stored in separate file(s) so they are easy to maintain.
If you relocate a topic file or give it a better name, just change the reference to the key. Any menu or reltable that refers to the topic will not have to be found and fixed.
Very handy if you need to generate many documents using your topics.


On 2020-07-03 3:13 p.m., Paul Mazaitis wrote:
Hi all,

I've got a fairly hefty set of topics (4k+) that have sparse relationships on multiple axes.

By analogy: 

- some of my topics have a shape (square, triangle, circle, etc.)
- some of my topics have a color (orange, blue, grey, etc.)
- some of my topics have both shape and color
- some of my topics have neither (a majority, thankfully)

What I'd really like to do is handle these relationships with reltables: set up the relationships in a map, and then (somehow) generate labeled lists in topics as appropriate (these topics share this shape; these topics share this color).

However, from what I can tell, reltables (and all of the resulting functionality) only operate on one dimension; a union is made of all available reltables, and all relationships are generated from that (and any extra information about a subgrouping is lost). But! I may have missed something, so I hope it's okay to ask:

Is there any way to get multiple kinds of topic relationships into a DITA documentation set without hard coding the links?

Many thanks!

     -Paul

Relationships on Multiple Axes? #reltable

Paul Mazaitis
 

Hi all,

I've got a fairly hefty set of topics (4k+) that have sparse relationships on multiple axes.

By analogy: 

- some of my topics have a shape (square, triangle, circle, etc.)
- some of my topics have a color (orange, blue, grey, etc.)
- some of my topics have both shape and color
- some of my topics have neither (a majority, thankfully)

What I'd really like to do is handle these relationships with reltables: set up the relationships in a map, and then (somehow) generate labeled lists in topics as appropriate (these topics share this shape; these topics share this color).

However, from what I can tell, reltables (and all of the resulting functionality) only operate on one dimension; a union is made of all available reltables, and all relationships are generated from that (and any extra information about a subgrouping is lost). But! I may have missed something, so I hope it's okay to ask:

Is there any way to get multiple kinds of topic relationships into a DITA documentation set without hard coding the links?

Many thanks!

     -Paul

[ann][webinar] Collaboration Made Simple with Oxygen Content Fusion #Oxygen

alin_belu@...
 

Hello, 
 
Our series of weekly live events continues next Wednesday (July 8) with the “Collaboration Made Simple with Oxygen Content Fusion” webinar! 
 
Mihaela Calotescu, software developer at Syncro Soft, will present the various ways Oxygen Content Fusion can empower technical authors with the use of its latest features. In this webinar, you will learn how you can use Oxygen Content Fusion to: 
* Share or reassign ownership of tasks 
* Assign tasks only to specific collaborators 
* Share complex DITA files that contain key definitions and profiled content 
* Share interlinked files in any XML format 
* Share with SMEs templates that will be filled in with technical data 
* Receive content drafts from SMEs in a structured format 
* Track the document revisions 
 
This is a free event and you can register at http://www.oxygenxml.com/evs2020-7.html 
 
Check the full list of the upcoming webinars and follow the links to see more details and register for free: 
 
Best regards, 
Alin

--
Alin Belu
Oxygen XML Editor

Re: XSL-FO two-page layout

renderxxep
 

Below is an XSL that you could adopt to the Antennahouse area tree format. This does n-up processing of RenderX's intermediate format to 2-up and more.

From the comments:

        This style sheet performs transformations on the XEP intermediate format (XEPOUT)

        to format various layouts of documents. 

        

        It is based on the <xep:transform> element which can apply an affine matix

        transformation to content. This is used to shrink pages to fit within the

        output page. It is also based on the <xep:translate> element to move pages

        in a grid layout in the new document.

        

        The stylesheet is used to take an input document and create various styles of output

        by shrinking and translating input pages from the document into a new output document

        with these pages.

        

        It does assume all the pages are uniform, all being the same dimensions of the first

        page. The scaling and configuration are based on this layout. It does work woth both

        landscape and portrait documents. And of course, it does not work with documents with

        intra-document links or bookmarks. It is meant to produce a print output document with

        the desired n-up layout.

        2-up: Two per page

            opposite final layout

            scaled to (width/height) for portrait

            scaled to (height/width) for landscape

            2 cols, 1 row for portrait

            1 col, 2 rows for landscape

        4-up: Four per page

            same final layout

            scaled to 1/2

        6-up: Six per page

            opposite final layout

            scaled to 1/2 (width/height) for portrait

            scaled to 1/2 (height/width) for landscape

            3 cols, 2 rows for portrait

            2 cols, 3 rows for landscape

        9-up: Nine per page 

            same final layout

            scaled to 1/3

        16-up: Sixteen per page 

            same final layout

 

            scaled to 1/4

 

Re: XSL-FO two-page layout

tokukobayashi2002
 

Hi!

AH Formatter can treat each page of PDF as a vector image. Therefore, if you want to place two A5 pages on top of an A4 page, you can do the following. The first step is to generate a PDF with A5 page master. Next, using the page master of A4, place two pages of A5 PDF on it in order as images.

I remember making samples a long time ago. If you need help, please inform me.

Best regards,

Tokushige Kobayashi
Antenna House, Inc.


2020-06-30 03:16 に Nicholas Mucks via groups.io さんは書きました:

Hi Mica,
That's it: page imposition.
We're using Antenna House.
How might you approach this instead?
On Monday, June 29, 2020, 10:17:10 AM PDT, Mica Semrick
<mica@...> wrote:
Hey Nick,
Which PDF formatter are you using?
I think your approach might be off, as this generally isn't page level
formatting. The feature is called "page imposition."
-m
On June 29, 2020 9:15:22 AM PDT, "Nicholas Mucks via groups.io"
<urbanrobots=yahoo.com@groups.io> wrote:

Hello,
We're trying to create a two-page layout where each printed page has
two pages on it. Although creating a two-column layout is simple
enough, we're having difficult with the static content since it
still shows one footer that spans the bottom of the page across the
two columns.
Has anyone created a PDF that displays two pages side by side in
landscape orientation?
Thanks for your time.
- Nick
Links:
------
[1] https://dita-users.groups.io/g/main/message/45571
[2] https://groups.io/mt/75195062/2985344
[3] https://dita-users.groups.io/g/main/post
[4] https://dita-users.groups.io/g/main/editsub/2985344
[5] https://dita-users.groups.io/g/main/leave/defanged

How correct is your Simplified Chinese Index? #DITA-OT #PDF

Toshihiko Makita
 

Hi List,

 

If you are publishing DITA documents that contains <indexterm>, you may make index pages by specifying backmatter/booklists/indexlist. Also if your publication contains Simplified Chinese localization, the indexlist will be generated by sorting <indexterm> using following sort keys:

 

   pinyin-reading/strokes/radical/GB0 code

 

However there is very headache problem in making index pages. A Hanzi (Chinese Character) has sometimes plural pinyin readings and  only the most frequently used pinyin reading is adopted for sorting/grouping <indexterm>.

 

For instance:

 

  1. "速系" has reading "tiao2 su4 xi4 tong3" and the meaning is "Speed control system".
  2. "调查结" has reading "diao4 cha2 jie2 guo3" and the meaning is "Survey results".

 

1. should be grouped into "T" and 2. should grouped into "D" according to its readings.

Surprisingly they are all grouped into "D" group unconditionally because  representative reading defined in Unihan database (ftp://unicode.org/Public/13.0.0/ucdxml/ucd.unihan.flat.zip) for "" is "diao4".

 

Here is sample PDF result generated by PDF2 plug-in (DITA-OT 3.5.1).




This is well-known problem and is not avoidable as long as the index-sorting program uses ICU (http://userguide.icu-project.org/collation) or Java collator directly. (Both collator may uses pinyin-reading defined in Unihan database)

We (Antenna House) has been working on this problem and developed new dictionary based index sorting in I18N Index Library (https://www.antennahouse.com/i18n-index-library). This is still under the development but we can generate correct results for above example. (Outputted via PDF5-ML plug-in https://github.com/AntennaHouse/pdf5-ml)



The dictionary based index-sorting outputs the following log:

     [xslt] [readKeyFile][DEBUG] Unihan database entry=41377
     [xslt] [readDictionaryFile][DEBUG] Dictionary entry=189082
     [xslt] [readDictionaryFile][DEBUG] User dictionary entry=5
     [xslt] [getKey][DEBUG] Processing indexterm=调速系统
     [xslt] [processHanziKey][DEBUG] Got pinyin from dictionary! word=调速 pinyin=tiao2 su4
     [xslt] [processHanziKey][DEBUG] Got pinyin from dictionary! word=系统 pinyin=xi4 tong3
     [xslt] [getKey][DEBUG] Processing indexterm=调查结果
     [xslt] [processHanziKey][DEBUG] Got pinyin from dictionary! word=调查结果 pinyin=diao4 cha2 jie2 guo3

It shows that dictionary based method is useful for generating Simplified Chinese index pages. We hope to refine this library function more accurate to automatically generate index pages.

If you have any interest about this library, could you offer your Simplified Chinese DITA publication data for estimation?

  1. The needed file is merged middle file in the temporary directory that DITA-OT generates. It is usually named xxx_MERGED.xml (xxx is map file name).
  2. If you offer the merged middle file, we will extract only <indexterm> and generates index pages both usual method and dictionary based method.
  3. We will send you the both results and analyzing report with them in no charge.

Hope this helps your DITA publishing.

Regards,

-- 
/*----------------------------------------------------------------------- 
 Toshihiko Makita
 Development Group. Antenna House, Inc. Ina Branch
 E-Mail tmakita@...
 Web site:
 http://www.antenna.co.jp/
 http://www.antennahouse.com/
 ------------------------------------------------------------------------*/ 








Re: XSL-FO two-page layout

Jonathan Hanna
 

Hi Nick,

I publish my docs using a 5.5"x8.5" size (US-Statement) and then use Acrobat to print two pages on one printed page. Likewise, if you're using A4 paper, you can publish your document as an A5 size.

- Jonathan

Re: XSL-FO two-page layout

Toshihiko Makita
 

Hi Nick,

Although creating a two-column layout is simple enough, we're having difficult with the static content since it still shows one footer that spans the bottom of the page across the two columns.
Unfortunately AH Formatter does not support static contents per column. 
What content do you want to put into static contents? If it is only footnote, specifying axf:footnote-position="column" may be useful.

Regards,
-- 
/*----------------------------------------------------------------------- 
 Toshihiko Makita
 Development Group. Antenna House, Inc. Ina Branch
 Web site:
 http://www.antenna.co.jp/
 http://www.antennahouse.com/
 -----------------------------------------------------------------------*/


Re: XSL-FO two-page layout

David H
 

Hi Nick,

From within Acrobat, go to File -> Properties -> Initial View

The Page layout drop down has 4 options for Two-Up layouts.

It might be possible to use XSL:FO to define a page layout? AH might have an extension to do this?

Alternatively, post process with an Acrobat Batch Script or JavaScript to change the page layout.

HTH,
David


Hi Mica,
That's it: page imposition.
We're using Antenna House.

How might you approach this instead?

On Monday, June 29, 2020, 10:17:10 AM PDT, Mica Semrick <mica@...> wrote:


Hey Nick,

Which PDF formatter are you using?

I think your approach might be off, as this generally isn't page level formatting. The feature is called "page imposition."

-m

On June 29, 2020 9:15:22 AM PDT, "Nicholas Mucks via groups.io" <urbanrobots@...> wrote:
Hello,
We're trying to create a two-page layout where each printed page has two pages on it.  Although creating a two-column layout is simple enough, we're having difficult with the static content since it still shows one footer that spans the bottom of the page across the two columns.

Has anyone created a PDF that displays two pages side by side in landscape orientation?

Thanks for your time.
- Nick

Re: Chapter numbering issue when using <topicgroup>

Chris Brand
 

Dear Toshihiko

I'm taking a bow. Your plugin works like a charm. Thank you very much for this nice feature!

That should be part of the DITA-OT by default.

Best regards
Chris.


Am 27.06.20 um 16:05 schrieb Toshihiko Makita:

Hi Chiris,

Sorry for the late reply.

As PDF2 plug-in has extension point named "org.dita.pdf2.xsl.topicmerge", you can override default topicmerge stylesheet processing by making plug-in.

Here is my example.

https://1drv.ms/u/s!AkbL99fLhxKUhp50UTIXM1xI7FSmlg?e=2Jrj9Q

You can integrate this plug-in and change PDF2 topicmerge processing. In my testing, I could succeed to remove topicgroup elements from the map portion of the merged middle file in DITA-OT 2.5.4.

If there are any problems, please let me know.

Regards,

-- 
/*----------------------------------------------------------------------- 
 Toshihiko Makita
 Development Group. Antenna House, Inc. Ina Branch
 Web site:
 http://www.antenna.co.jp/
 http://www.antennahouse.com/
 -----------------------------------------------------------------------*/

Re: XSL-FO two-page layout

Mica Semrick
 

It doesn't look like Antenna House supports imposition (correct me if I'm wrong!), so I'd consider another tool to do the imposition.

In prepress, imposition is usually done by the RIP or DFE, but those applications demand printing and are quite expensive.

Here is a good article about post processing post script (which antenna house can output) using pstops: https://wiki.scribus.net/canvas/How_to_make_impositions_with_pstops

Here is a script to do 2-up imposition with Ghostscript: https://stackoverflow.com/a/30546987

If you're looking for something radically different, a PDF producer called ConTeXt supports imposition and could (maybe?) replace Antenna House et al. It to s a different beast, not XML nor XSL FO, but it is quite flexible. https://wiki.contextgarden.net/Imposition

-m



On June 29, 2020 11:16:01 AM PDT, "Nicholas Mucks via groups.io" <urbanrobots@...> wrote:
Hi Mica,
That's it: page imposition.
We're using Antenna House.

How might you approach this instead?

On Monday, June 29, 2020, 10:17:10 AM PDT, Mica Semrick <mica@...> wrote:


Hey Nick,

Which PDF formatter are you using?

I think your approach might be off, as this generally isn't page level formatting. The feature is called "page imposition."

-m

On June 29, 2020 9:15:22 AM PDT, "Nicholas Mucks via groups.io" <urbanrobots@...> wrote:
Hello,
We're trying to create a two-page layout where each printed page has two pages on it.  Although creating a two-column layout is simple enough, we're having difficult with the static content since it still shows one footer that spans the bottom of the page across the two columns.

Has anyone created a PDF that displays two pages side by side in landscape orientation?

Thanks for your time.
- Nick

Re: XSL-FO two-page layout

Nicholas Mucks
 

Hi Mica,
That's it: page imposition.
We're using Antenna House.

How might you approach this instead?

On Monday, June 29, 2020, 10:17:10 AM PDT, Mica Semrick <mica@...> wrote:


Hey Nick,

Which PDF formatter are you using?

I think your approach might be off, as this generally isn't page level formatting. The feature is called "page imposition."

-m

On June 29, 2020 9:15:22 AM PDT, "Nicholas Mucks via groups.io" <urbanrobots@...> wrote:
Hello,
We're trying to create a two-page layout where each printed page has two pages on it.  Although creating a two-column layout is simple enough, we're having difficult with the static content since it still shows one footer that spans the bottom of the page across the two columns.

Has anyone created a PDF that displays two pages side by side in landscape orientation?

Thanks for your time.
- Nick

Re: XSL-FO two-page layout

Mica Semrick
 

Hey Nick,

Which PDF formatter are you using?

I think your approach might be off, as this generally isn't page level formatting. The feature is called "page imposition."

-m


On June 29, 2020 9:15:22 AM PDT, "Nicholas Mucks via groups.io" <urbanrobots@...> wrote:
Hello,
We're trying to create a two-page layout where each printed page has two pages on it.  Although creating a two-column layout is simple enough, we're having difficult with the static content since it still shows one footer that spans the bottom of the page across the two columns.

Has anyone created a PDF that displays two pages side by side in landscape orientation?

Thanks for your time.
- Nick

XSL-FO two-page layout

Nicholas Mucks
 

Hello,
We're trying to create a two-page layout where each printed page has two pages on it.  Although creating a two-column layout is simple enough, we're having difficult with the static content since it still shows one footer that spans the bottom of the page across the two columns.

Has anyone created a PDF that displays two pages side by side in landscape orientation?

Thanks for your time.
- Nick

Re: Chapter numbering issue when using <topicgroup>

Toshihiko Makita
 

Hi Chiris,

Sorry for the late reply.

As PDF2 plug-in has extension point named "org.dita.pdf2.xsl.topicmerge", you can override default topicmerge stylesheet processing by making plug-in.

Here is my example.

https://1drv.ms/u/s!AkbL99fLhxKUhp50UTIXM1xI7FSmlg?e=2Jrj9Q

You can integrate this plug-in and change PDF2 topicmerge processing. In my testing, I could succeed to remove topicgroup elements from the map portion of the merged middle file in DITA-OT 2.5.4.

If there are any problems, please let me know.

Regards,

-- 
/*----------------------------------------------------------------------- 
 Toshihiko Makita
 Development Group. Antenna House, Inc. Ina Branch
 Web site:
 http://www.antenna.co.jp/
 http://www.antennahouse.com/
 -----------------------------------------------------------------------*/

Tracking mentions for an index or glossary?

Daud Vyd
 

While typing in a <p> or other tag, is it possible to annotate content so that it can be ad-hoc searched while working in Oxygen and also added to a dynamically generated index or glossary? For example, how would you markup this DITA topic:


<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
<topic id="genre">
    <title>Genre</title>
    <body>
        <p>Genre refers to the broad artistic category of a story while setting refers to specific example of a genre. Genre helps to determine the types of people and places a story might include without identifying named instances. Setting provides named instances and richly described details. For example, Fantasy (genre) often includes wizards and castles while Arthurian Legend (setting) describes Merlin and Camelot in particular.
    </body>
</topic>


Merlin is:
  • an instance-of a person
  • a child-of the Authorian Legend setting
Authorian Legend is:
  • an instance-of a setting
  • a parent-of Merlin
Fantasy is:
  • a instance-of a genre
  • a parent-of Authorian Legend

Is it possible to markup the text so that I can later query across all DITA files for the relationships described in bullet points or for a list of mentioned genres and where they are discussed? Could I insert a dynamically generated list of these mentions at the bottom of the Genre DITA page above to display in the final document?

Incidentally, Setting will be a DITA topic like Genre. Should every mention of these words be hyperlinked? In MS Word, I might just capitalize them and display in italics or bold them like I've done here.


Thank you,
d. vyd

[ann][webinar] Tailored Authoring Experience with Oxygen Web Author #Oxygen

alin_belu@...
 

Hello everyone, 
 
“Tailored Authoring Experience with Oxygen Web Author”, the 6th live event from our current weekly series of webinars, will take place on July 1st. 
 
Bogdan Dumitru, Web Author software developer, aims to inspire you with some of the most exciting ways to improve your authoring experience. You will learn about the various ways Web Author can be customized and the new framework customizations. Some of the subjects that will be discussed include:
* Validation for Markdown documents 
* Text-to-markup corrections 
* How to easily navigate through large documents with the Outline view 
* In-place actions 
* Diff as a service 
 
This is a free event and you can register at http://www.oxygenxml.com/evs2020-6.html
 
Check the full list of the upcoming webinars and follow the links to see more details and register for free: 
 
Best regards, 
Alin


--
Alin Belu
Oxygen XML Editor

Re: Help customising PDF plugin for displaying related information #DITA-OT

chichak1995@...
 

Hi Dragomir,

I think that you need to edit rel-links.xsl file. There is a template that matches linklist, maybe it is located there. 

Good luck
oJun,

Help customising PDF plugin for displaying related information #DITA-OT

Ozana Dragomir
 

Hi all,

I need some help customizing the DITA-OT PDF plugin (currently using DITA-OT 3.4.1).

We use reltables with different types of entries for the destination, for example:
  • cross-refences to other topics within the same book
<topicref keyref="key_A"/>

  • reference to topics which may or may not be within the same book:
<topicref keyref="key_B" scope="peer">
  <topicmeta>
    <linktext>For more information, see the <ph><cite>ABC</cite></ph> document.</linktext>
   </topicmeta>
</topicref>

  • static references to other documents:
<topicref>
    <topicmeta>
        <linktext>See the <ph><cite>BLABLA</cite></ph> document </linktext>
    </topicmeta>
</topicref>

The cross-references to topics within the same book will be grouped under a "Related Topics" heading. The other ones will be grouped under a "Related Information" heading.

I would like in each case to display the related info as a bulleted list. For example:

Related Topics:
  • Introduction
  • Configuring Stuff
  • More about stuff
Related Information:
  • For details about this, see ABC Core User Guide
  • BLABLA Reference Manual

What I am getting at the moment is this:

Related Topics:
Introduction
Configuring Stuff
More about stuff
Related Information:
For details about this, see ABC Core User Guide
BLABLA Reference Manual

I can "hack" the one using <linktext> to add a bullet in the beginning, but that's as far as I got.

I've been looking at links.xsl in the PDF plugin (we have already customised some of the templates in links.xsl) but I can't figure out which template is the one I need to edit and how.

Any help is appreciated :)


Thanks a lot,
Ozana