Date   

Re: PDF: suppress auto-link generation when encountering URL in text? #PDF

Patricia Billard
 

I'm afraid it is an Acrobat "feature"
When the file is opened in Acrobat, Acrobat autodetects things that look like links and mailto. 
Here are a few posts about the issue.  The first one talks about links NOT working, but the answer describes how what's happening with the Adobe autodetect feature.  It talks about disabling the feature, but I think that's on a user-by-user basis, not something you can do for file generation. The feature can be enabled/disabled by selecting/deselecting the General > "Create links from URLs" option in the Preferences dialog.  (Please note that the Preferences dialog is available in Acrobat Pro, Standard, and Reader desktop apps only.)
I'm not aware of ways to disable it from source content, but one blog post I saw talked about using "hair spaces" in the content to fool the autodetection.

https://community.adobe.com/t5/acrobat-reader-mobile/why-don-t-pdf-links-work-this-is-a-serious-problem/td-p/7866289?page=1
https://blogs.adobe.com/acrolaw/2013/03/removing-hyperlinks-from-a-pdf-and-featuregotcha/
https://acrobatusers.com/forum/pdf-creation/how-defeat-automatic-creation-hot-email-links/


Re: PDF: suppress auto-link generation when encountering URL in text? #PDF

Larry Kollar
 

You were correct! Acrobat's Preferences -> General tab -> uncheck "Create Links from URLs."

Personally, I like having URLs made clickable, but I can see why others might not.


Re: PDF: suppress auto-link generation when encountering URL in text? #PDF

Huntley Eshenroder
 

As you fear, I believe this is a property in Acrobat. You should be able to turn it off in the Acrobat preferences and observe if it still happens.


PDF: suppress auto-link generation when encountering URL in text? #PDF

Larry Kollar
 

One of our other writers pointed out that URLs appearing as content get turned into links (without extra formatting) when publishing PDF. Is there a way to turn that off? I didn't see any properties in the online docs that looked like they would help. Is this something we can do without performing major surgery on the toolkit? We're using 2.5.4 with a CCMS, if that makes a difference. Searching the archive didn't turn up anything for me.

I remember LwDITA versions <= 2.0.2 would choke when they hit URLs in MDITA content, unless wrapped in link markup. IIRC, it was a problem with a Java lib. That may be relevant. I just hope it's not something Acrobat's doing.

Thanks in advance for any help!


Re: Inserting Content Before a ToC #PDF #DITA-OT

Larry Kollar
 

We customized the PDF plugin to insert revision history after the title page. Definitely use the bookmap for this kind of thing.


Re: Reuse - best practices #reuse

ekimber@contrext.com
 

Yes, one of the values of keyrefs is that it creates a level of indirection between the initial reference to something (a conref, an xref, a topicref from a map) and the thing itself.

This indirection enables several important things:

1. Keeps the references separate from the details of where the referenced thing is at any given time. This lets you move the target thing around, rename it, etc., without breaking all the links to it. When the details of the thing change you only have to update the key definition(s) that point to it. This value of key references is independent of any re-use you might do not do. It simply makes your content much less fragile in general.

2. Allows the same reference to resolve to *different* things in different use contexts. This is essential when you are doing reuse so that the same topic (or re-used map) can have links that point to a single, invariant, key name where the key name may resolve to different targets in the context of different maps. And here by "target" I mean both things that you point to (topics, images, external resources like web sites) and text values (i.e., keys used to create "variable" text).

Cheers,

E.

--
Eliot Kimber
http://contrext.com


On 3/3/20, 12:16 PM, "Matt Lorenzi via Groups.Io" <main@dita-users.groups.io on behalf of mjlorenzi=yahoo.com@groups.io> wrote:

I think one of the biggest concerns I have is losing track of the original "home" of a topic. It isn't always known ahead of time which topics maybe become common to other models; it might not even be known at the time that other models are coming along. So I am sure in practice you simply do a topicref to the topic needed - wherever it may be. I sense this is where the power of keyrefs come in. I need more coffee to wrap my head around this.


Re: Reuse - best practices #reuse

Matt Lorenzi
 

I think one of the biggest concerns I have is losing track of the original "home" of a topic. It isn't always known ahead of time which topics maybe become common to other models; it might not even be known at the time that other models are coming along. So I am sure in practice you simply do a topicref to the topic needed - wherever it may be. I sense this is where the power of keyrefs come in. I need more coffee to wrap my head around this.


Re: Reuse - best practices #reuse

Matt Lorenzi
 

This is great advice. I am still only starting to get my feet wet with keyrefs. Playing around with using them for product names and other variables - not so much fore referencing topics - but I can see the power behind doing so.


Re: Best way to change @alt to <alt> #DITAv2-0 #images

Roger Sheen
 

On Monday, 2020-03-02, at 21:15 CET, Kristen James Eberlein wrote:

What have folks found to be the best/easiest/cleanest way to change
@alt to <alt> in DITA source?

Several plug-ins are available in the DITA-OT plug-in registry to handle these cases.

Robert Anderson’s deprecated-dita plug-in reports markup like @alt attributes:
https://www.dita-ot.org/plugins#!org.metadita.deprecated.

For usage instructions, see https://github.com/robander/deprecated-dita.

Jason Fox’s Validator plug-in builds on this report to automatically fix deprecated markup:
https://www.dita-ot.org/plugins#!com.here.validate.svrl.

For details, see https://github.com/jason-fox/com.here.validate.svrl.

Hope that helps,

Roger


--

https://www.dita-ot.org/dev/ · DITA Open Toolkit Documentation


Re: Best way to change @alt to <alt> #DITAv2-0 #images

Radu Coravu
 

I would go with an XSLT refactoring operation, the example in the Oxygen User's Manual is for exactly this case of changing a DITA image @alt to <alt>:

https://www.oxygenxml.com/doc/ug-editor/topics/custom_operation_sample-x-tools.html

Regards,
Radu

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

On 3/2/2020 11:38 PM, ekimber@... wrote:
This might be a slightly better formulation:
From:
<image(\s*href="[^"]+")?\s+alt="([^"]+)"(\s*href="[^"]+")?/>
To:
<image$1$3><alt>$2</alt></image>
That should handle the attributes being in either order.
Cheers,
E.
--
Eliot Kimber
http://contrext.com
On 3/2/20, 2:50 PM, "ekimber@..." <main@dita-users.groups.io on behalf of ekimber@...> wrote:
If the markup is reliable then a global regular expression search and replace is sufficient, which of course is easy to do with Oxygen. Something like:
From:
<image(\s+href="[^"]+")\s+alt="([^"]+)"\s*>
To:
<image$1><alt>$2</alt></image>
Cheers,
E.
--
Eliot Kimber
http://contrext.com
On 3/2/20, 2:15 PM, "Kristen James Eberlein" <main@dita-users.groups.io on behalf of @keberlein> wrote:
What have folks found to be the best/easiest/cleanest way to
change @alt to <alt> in DITA source? To clarify:
Deprecated usage:
<image href="image.png" alt="My wonderful image"/>
New usage:
<image href="image.png">
<alt>My wonderful image</alt>
</image>
@alt has been deprecated since DITA 1.2 and will be removed in
DITA 2.0.
I'm currently working with a small group that has about a
thousand images with @alt; I'd love to be able to fix this for
them ...
--
Best,
Kris
Kristen James Eberlein
Chair, OASIS DITA Technical Committee
OASIS Distinguished Contributor
Principal consultant, Eberlein Consulting LLC
www.eberleinconsulting.com <http://www.eberleinconsulting.com>
+1 919 622-1501; kriseberlein (skype)


Re: Reuse - best practices #reuse

Ron Wheeler
 

With naming scheme one, are you not going to be more puzzled when you reuse "How to Build Something-AA" in "Pub-Model-BB"?

Another alternative might be:

Products
    /Build
        Common Topics
        How to Build AA
        How to Build BB
    /Fix
        Common Topics
        How to Fix AA
        How to Fix BB
    /Specs
        Common Topics
        AA
        BB
    /Health&Safety
        Common Topics
            English
            French
        AA
            English
            French
        BB
            English
            French
    /Marketing
        Common Topics
            English
            French
        AA
            English
            French
        BB

            English
            French

This might work well if you have different teams (Manufacturing, Customer Service, Product Engineering, Product Safety, Marketing, etc.) responsible for maintaining the documentation.

I am not sure that there is only 1 right answer but you might find it helpful to hypothesize several reuse scenarios to see how easy it is to determine the hierarchy of a topic when you might have it in several documents.
I would be tempted to use mindmapping to explore potential structures and to think about how the documentation will be maintained.

On the good side of DITA, if you use keyrefs to tie topic names(keys) to file URIs, you can change your mind later and have only 1 map to alter if you change the physical organization of the topic files.
With keys, you can afford to be wrong as long as it works and fix it easily as soon as it does not work.

Ron


On 2020-03-02 7:41 p.m., Matt Lorenzi via Groups.Io wrote:

One other reuse issue I have has to do with file naming. I struggle with naming conventions and how detailed I should be with file names. I will start with Pub-Model-AA.

These are the two ways I would think you could name the files, see below:

Pub-Model-AA/
topics/            How do Build Something-AA
           How to Fix Something-AA
media/
or

Pub-Model-AA/
topics/            How do Build Something
           How to Fix Something
media/

Which method is least likely to cause confusion? If I go with the first method I will always know the task: How do Build Something-AA belongs to model-AA, even I reuse and reference How do Build Something-AA in model-BB.
But if I use just use: How do Build Something, I can still use it across multiple documents, I just won't know immediately where it belongs. It was suggested to go with this latter method as the parent folder will identify the model.

On the other hand, I've also read one should make the file name as specific as possible, but am I taking this too literally by including the model name in each file name?

 


Re: Reuse - best practices #reuse

Matt Lorenzi
 

One other reuse issue I have has to do with file naming. I struggle with naming conventions and how detailed I should be with file names. I will start with Pub-Model-AA.

These are the two ways I would think you could name the files, see below:

Pub-Model-AA/
topics/
           How do Build Something-AA
           How to Fix Something-AA
media/
or

Pub-Model-AA/
topics/
           How do Build Something
           How to Fix Something
media/

Which method is least likely to cause confusion? If I go with the first method I will always know the task: How do Build Something-AA belongs to model-AA, even I reuse and reference How do Build Something-AA in model-BB.
But if I use just use: How do Build Something, I can still use it across multiple documents, I just won't know immediately where it belongs. It was suggested to go with this latter method as the parent folder will identify the model.

On the other hand, I've also read one should make the file name as specific as possible, but am I taking this too literally by including the model name in each file name?

 


Re: Best way to change @alt to <alt> #DITAv2-0 #images

ekimber@contrext.com
 

This might be a slightly better formulation:

From:

<image(\s*href="[^"]+")?\s+alt="([^"]+)"(\s*href="[^"]+")?/>

To:

<image$1$3><alt>$2</alt></image>

That should handle the attributes being in either order.

Cheers,

E.
--
Eliot Kimber
http://contrext.com


On 3/2/20, 2:50 PM, "ekimber@..." <main@dita-users.groups.io on behalf of ekimber@...> wrote:

If the markup is reliable then a global regular expression search and replace is sufficient, which of course is easy to do with Oxygen. Something like:

From:

<image(\s+href="[^"]+")\s+alt="([^"]+)"\s*>

To:

<image$1><alt>$2</alt></image>

Cheers,

E.

--
Eliot Kimber
http://contrext.com


On 3/2/20, 2:15 PM, "Kristen James Eberlein" <main@dita-users.groups.io on behalf of @keberlein> wrote:










What have folks found to be the best/easiest/cleanest way to
change @alt to <alt> in DITA source? To clarify:
Deprecated usage:
<image href="image.png" alt="My wonderful image"/>

New usage:
<image href="image.png">
<alt>My wonderful image</alt>
</image>

@alt has been deprecated since DITA 1.2 and will be removed in
DITA 2.0.
I'm currently working with a small group that has about a
thousand images with @alt; I'd love to be able to fix this for
them ...

--
Best,
Kris

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


Re: Best way to change @alt to <alt> #DITAv2-0 #images

Wayne Brissette
 

I was going to suggest that as well, but thought, really XSLT should be used here since technically XML isn’t just text. But you know me… I’ll use whatever tool is the fastest and easiest and in this case I do think a regex would solve it. 



On Mar 2, 2020, at 2:50 PM, ekimber@... wrote:

If the markup is reliable then a global regular expression search and replace is sufficient, which of course is easy to do with Oxygen. Something like:

From:

<image(\s+href="[^"]+")\s+alt="([^"]+)"\s*>

To:

<image$1><alt>$2</alt></image>

Cheers,

E.

--
Eliot Kimber
http://contrext.com




Re: Best way to change @alt to <alt> #DITAv2-0 #images

ekimber@contrext.com
 

If the markup is reliable then a global regular expression search and replace is sufficient, which of course is easy to do with Oxygen. Something like:

From:

<image(\s+href="[^"]+")\s+alt="([^"]+)"\s*>

To:

<image$1><alt>$2</alt></image>

Cheers,

E.

--
Eliot Kimber
http://contrext.com


On 3/2/20, 2:15 PM, "Kristen James Eberlein" <main@dita-users.groups.io on behalf of @keberlein> wrote:










What have folks found to be the best/easiest/cleanest way to
change @alt to <alt> in DITA source? To clarify:
Deprecated usage:
<image href="image.png" alt="My wonderful image"/>

New usage:
<image href="image.png">
<alt>My wonderful image</alt>
</image>

@alt has been deprecated since DITA 1.2 and will be removed in
DITA 2.0.
I'm currently working with a small group that has about a
thousand images with @alt; I'd love to be able to fix this for
them ...

--
Best,
Kris

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


Re: Best way to change @alt to <alt> #DITAv2-0 #images

Zoë Lawson
 

I’m sure that there’s a way to do it with Oxygen refactoring.

However I usually go towards an XSLT script that copies everything, with a template for fixing whatever needs fixing.

Since I generally am doing some sort of major source control restructure and cleanup every 18 months or less, I have some scripts lying around to start from.

Zoë

Zoë Lawson


From: main@dita-users.groups.io <main@dita-users.groups.io> on behalf of Kristen James Eberlein <kris@...>
Sent: Monday, March 2, 2020 3:15:29 PM
To: dita-users@groups.io <dita-users@groups.io>
Subject: [dita-users] Best way to change @alt to <alt> #DITAv2.0 #images
 

What have folks found to be the best/easiest/cleanest way to change @alt to <alt> in DITA source? To clarify:

Deprecated usage:
<image href="image.png" alt="My wonderful image"/>

New usage:
<image href="image.png">
    <alt>My wonderful image</alt>
</image>

@alt has been deprecated since DITA 1.2 and will be removed in DITA 2.0.

I'm currently working with a small group that has about a thousand images with @alt; I'd love to be able to fix this for them ...

--
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)


Best way to change @alt to <alt> #DITAv2-0 #images

Kristen James Eberlein
 


What have folks found to be the best/easiest/cleanest way to change @alt to <alt> in DITA source? To clarify:

Deprecated usage:
<image href="image.png" alt="My wonderful image"/>

New usage:
<image href="image.png">
    <alt>My wonderful image</alt>
</image>

@alt has been deprecated since DITA 1.2 and will be removed in DITA 2.0.

I'm currently working with a small group that has about a thousand images with @alt; I'd love to be able to fix this for them ...

--
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)


Medtronic peeps?

Bill Burns
 

Greetings,

 

I’m looking to get a hold of anyone from Medtronic. Please shoot me an email. I have a question about a position.

 

Thanks,

 

Bill Burns

wdburns63@...

+1.208.794.5709

 


Virus-free. www.avast.com


Re: Inserting Content Before a ToC #PDF #DITA-OT

Mica Semrick
 

If you use the Bookmap type of map, there are elements to do it automatically.

Otherwise, you'll need to make a DITA-OT plugin customization to do so.


On February 28, 2020 9:40:07 AM PST, Wanda Phillips <wanda.jane@...> wrote:
I have a client looking at switching to DITA and they've been putting content ahead of the ToC, I don't know if I can replicate that in DITA output or if I will simply restructure their book (more than I am currently), but in case they make it a priority, is there a way to insert content ahead of the ToC in PDF output?

Wanda
Write Livelihood


Inserting Content Before a ToC #PDF #DITA-OT

Wanda Phillips
 

I have a client looking at switching to DITA and they've been putting content ahead of the ToC, I don't know if I can replicate that in DITA output or if I will simply restructure their book (more than I am currently), but in case they make it a priority, is there a way to insert content ahead of the ToC in PDF output?

Wanda
Write Livelihood