[XXE] DITA attribute collection-type="family" - no visible result in web help

[Grundtvig Nielsen Niels]

Good morning! I've found your reply about this question from 24 February 2014 
... and just wanted to check: thanks to our IT "support", I'm still using XXE 
6.1.0. Can the DITAC in the current version of XXE (6.5?) now generate "related 
links" in WebHelp output?

from Hussein Shafie 
24 February 2014

What you want works fine when generating *plain* *HTML*, but is currently not 
implemented when generating Web Help, HTML Help, EPUB, etc, that is, HTML-based 
formats providing the user with a "native" way to navigate between topics.
We'll try to remove this limitation in the next version of ditac.

from Niels Grundtvig Nielsen 
24 February 2014

Making good progress converting a data dictionary from unmanageable single Word 
file into manageable DITA topics, but I've hit a small snag: I've been advised 
that collection-type="family" is the way to generate links between topics at 
the same level, but I haven't managed to make this work yet. (even after 
checking DITA Support in the documentation set)

Niels Grundtvig Nielsen
technical author T
you know what you're talking about - I can help you say it




Worldline SA/NV - Chaussee de Haecht 1442 Haachtsesteenweg
- 1130 Brussels - Belgium
RPM-RPR Bruxelles-Brussel - TVA-BTW BE 0418.547.872
Bankrekening-Compte Bancaire-Bank Account 310-0269424-44
BIC BBRUBEBB - IBAN BE55 3100 2694 2444

"The information contained in this e-mail and any attachment there to be 
confidential and may contain information which is protected by intellectual 
property rights.
This information is intended for the exclusive use of the recipient(s) named 
above.
This e-mail does not constitute any binding relationship or offer toward any of 
the addressees.
If you are not one of the addressees , one of their employees or a proxy holder 
entitled to hand over this message to the addressee(s), any use of the 
information contained herein (e.g. reproduction, divulgation, communication or 
distribution,...) is prohibited.
If you have received this message in error, please notify the sender and 
destroy it immediately after.
The integrity and security of this message cannot be guaranteed and it may be 
subject to data corruption, interception and unauthorized amendment, for which 
we accept no liability."

--
XMLmind XML Editor Support List
xmleditor-support@xmlmind.com
http://www.xmlmind.com/mailman/listinfo/xmleditor-support

Re: [XXE] DITA attribute collection-type="family" - no visible result in web help

[Hussein Shafie]

On 01/11/2016 09:13 AM, Grundtvig Nielsen Niels wrote:

Good morning! I've found your reply about this question from 24 February
2014 … and just wanted to check: thanks to our IT "support", I'm still
using XXE 6.1.0. Can the DITAC in the current version of XXE (6.5?) now
generate "related links" in WebHelp output?


Yes, but for that, you must specify XSLT stylesheet parameter:

ignore-navigation-links=no

By default, it's ignore-navigation-links=yes for Web Help.

See 
http://www.xmlmind.com/ditac/_distrib/doc/manual/xsltParams.html#xsltParams__ignore-navigation-links





*from *Hussein Shafie 

24 February 2014

What you want works fine when generating *plain* *HTML*, but is
currently not implemented when generating Web Help, HTML Help, EPUB,
etc, that is, HTML-based formats providing the user with a "native" way
to navigate between topics.

We'll try to remove this limitation in the next version of ditac.

*from*Niels Grundtvig Nielsen 

24 February 2014

Making good progress converting a data dictionary from unmanageable
single Word file into manageable DITA topics, but I've hit a small snag:
I've been advised that collection-type="family" is the way to generate
links between topics at the same level, but I haven't managed to make
this work yet. (even after checking DITA Support in the documentation set)




--
XMLmind XML Editor Support List
xmleditor-support@xmlmind.com
http://www.xmlmind.com/mailman/listinfo/xmleditor-support

Re: [XXE] DITA attribute collection-type=family – no visible result in web help

[Hussein Shafie]

Sorry but my initial answer is incorrect. It already (as of ditac 
v2.2.1) works fine whatever the HTML-based output format.


If you want to instruct ditac to automatically generate ``traditional 
DITA navigation links'' whatever the HTML-based output format, suffice 
to pass XSLT stylesheet parameter ignore-navigation-links as 'no'.


Reference:

http://www.xmlmind.com/ditac/_distrib/doc/manual/xsltParams.html#xsltParams__ignore-navigation-links



On 02/25/2014 08:58 AM, n...@kbss27.be wrote:

Thanks for the quick explanation. I can see the logic of relying on the
left-hand navigation when it's present, but for a large topic-set – this
one is currently around 460, though thanks to XXE it's been remarkably
easy to prepare – I suspect users will collapse the minor topics; so it
could be a help to get the references to a set of level three topics.
The set 7.8.1 to 7.8.5 is typical for this content, with 26 top-level
topics.

I'll bear the explanation in case the project manager wants to try plain
.html


--
XMLmind XML Editor Support List
xmleditor-support@xmlmind.com
http://www.xmlmind.com/mailman/listinfo/xmleditor-support

Re: [XXE] DITA attribute collection-type=family – no visible result in web help

[ngn]

Thanks for the quick explanation. I can see the logic of relying on the left-hand navigation when it's present, but for a large topic-set – this one is currently around 460, though thanks to XXE it's been remarkably easy to prepare – I suspect users will collapse the minor topics; so it could be a help to get the references to a set of level three topics. The set 7.8.1 to 7.8.5 is typical for this content, with 26 top-level topics.I'll bear the explanation in case the project manager wants to try plain .htmlN

--
XMLmind XML Editor Support List
xmleditor-support@xmlmind.com
http://www.xmlmind.com/mailman/listinfo/xmleditor-support

[XXE] DITA attribute collection-type=family – no visible result in web help

[Niels Grundtvig Nielsen]

Making good progress converting a data dictionary from unmanageable single
Word file into manageable DITA topics, but I've hit a small snag: I've been
advised that collection-type=family is the way to generate links between
topics at the same level, but I haven't managed to make this work yet.
(even after checking DITA Support in the documentation set)

Here's the code for my tiny test-map. I've included the collection-type
attribute, but generating web-help from the map just gives me topic pages
for the four bsermsg topics and not a link in sight: what I was hoping for
was sibling links.

?xml version=1.0 encoding=UTF-8?
!DOCTYPE map PUBLIC -//OASIS//DTD DITA Map//EN
map.dtd
map id=um42hp84
  titleAardvark Specifications and Data Dictionary 2.8/title
  topicref href=avk_freq_bs.dita
topicref href=avk_freq_bs_01.dita/
topicref href=avk_freq_bs_02.dita
  topicref href=avk_freq_bs_03.dita/
  topicref href=avk_freq_bs_04.dita/
  topicref href=avk_freq_bs_05.dita/
  topicref href=avk_freq_bs_06.dita/
/topicref

topicref collection-type=family href=avk_freq_bs_07.dita
  topicref href=avk_freq_bsermsg_01.dita/
  topicref href=avk_freq_bsermsg_02.dita/
  topicref href=avk_freq_bsermsg_03.dita/
  topicref href=avk_freq_bsermsg_04.dita/
/topicref
  /topicref
/map

My manager is already impressed with the new web-help version; it would be
satisfying to be able to enrich the navigation with these sibling links.
Thanks in advance for guidance and advice!

N

--
XMLmind XML Editor Support List
xmleditor-support@xmlmind.com
http://www.xmlmind.com/mailman/listinfo/xmleditor-support

Re: [XXE] DITA attribute collection-type=family – no visible result in web help

[Hussein Shafie]

What you want works fine when generating *plain* *HTML*, but is 
currently not implemented when generating Web Help, HTML Help, EPUB, 
etc, that is, HTML-based formats providing the user with a ``native'' 
way to navigate between topics.


We'll try to remove this limitation in the next version of ditac.




-
Note than when generating plain HTML:
-

By default, the XXE configuration for DITA maps specifies XSLT 
stylesheet parameter chain-topics as 'yes'.


Because chaining topics this way (topics are linked by the means of 
small arrow icons) would be redundant with the DITA standard way of 
chaining topics (a link section found at the bottom of the topic), the 
links you expect are not generated.


Hence you simply need to specify XSLT stylesheet parameter 
chain-topics as 'no' to achieve what you want when generating plain HTML.





On 02/24/2014 11:40 AM, Niels Grundtvig Nielsen wrote:

Making good progress converting a data dictionary from unmanageable
single Word file into manageable DITA topics, but I've hit a small snag:
I've been advised that collection-type=family is the way to generate
links between topics at the same level, but I haven't managed to make
this work yet. (even after checking DITA Support in the documentation set)

Here's the code for my tiny test-map. I've included the collection-type
attribute, but generating web-help from the map just gives me topic
pages for the four bsermsg topics and not a link in sight: what I was
hoping for was sibling links.

?xml version=1.0 encoding=UTF-8?
!DOCTYPE map PUBLIC -//OASIS//DTD DITA Map//EN
map.dtd
map id=um42hp84
   titleAardvark Specifications and Data Dictionary 2.8/title
   topicref href=avk_freq_bs.dita
 topicref href=avk_freq_bs_01.dita/
 topicref href=avk_freq_bs_02.dita
   topicref href=avk_freq_bs_03.dita/
   topicref href=avk_freq_bs_04.dita/
   topicref href=avk_freq_bs_05.dita/
   topicref href=avk_freq_bs_06.dita/
 /topicref

 topicref collection-type=family href=avk_freq_bs_07.dita
   topicref href=avk_freq_bsermsg_01.dita/
   topicref href=avk_freq_bsermsg_02.dita/
   topicref href=avk_freq_bsermsg_03.dita/
   topicref href=avk_freq_bsermsg_04.dita/
 /topicref
   /topicref
/map

My manager is already impressed with the new web-help version; it would
be satisfying to be able to enrich the navigation with these sibling
links. Thanks in advance for guidance and advice!




--
XMLmind XML Editor Support List
xmleditor-support@xmlmind.com
http://www.xmlmind.com/mailman/listinfo/xmleditor-support