Date   

Re: WebHelp on a shoestring? #dita-ot #DITA-OT

Nancy Roberts
 

Hi Mark,

HTML5 is the backup plan. I was hoping to find another way, that's all.

Thanks!
Nancy


Re: hide and seek

Aaron Mehl
 

This I did, but I was referring to the actual document flow. I added topics to explain a topic. I now see that what I wanted was to streamline the published document so the end user wouldn't get bogged down or confused.
Aaron

On Saturday, February 27, 2021, 07:07:08 PM EST, selvats via groups.io <selvats@...> wrote:


Please use the toc=no attribute on the topicref for the topic to hide it from the TOC.


Re: WebHelp on a shoestring? #dita-ot #DITA-OT

Rodolfo M. Raya
 

Hello Nancy,

You can generate nice web help and other formats with Conversa, https://www.maxprograms.com/products/conversa.html 

Conversa is free and open source. It uses XMLMind's DITA Converter (ditac) to generate output from your DITA sources.

You can configure the appearance of the generated web help, although the default already looks good.

Give it a try, the price is not an obstacle :)

Regards,
Rodolfo 


On Sun, Feb 28, 2021 at 3:52 PM Nancy Roberts <nanr93@...> wrote:
Hi again,

I'm looking into providing webhelp for a single client I freelance for. What's the cheapest way to get webhelp output? Oxygen Editor offers a $200 personal license, which is still a lot for a single client. I've found a freeware editor (Codex), and of course the OT itself is free. Is there a free webhelp plugin anywhere to the OT? I can't find one that looks viable.

Thanks!
Nancy




Re: WebHelp on a shoestring? #dita-ot #DITA-OT

David Hollis
 

Hi Nancy,

What about DITA to WordPress?

HTH,
David

Hi again,

I'm looking into providing webhelp for a single client I freelance for. What's the cheapest way to get webhelp output? Oxygen Editor offers a $200 personal license, which is still a lot for a single client. I've found a freeware editor (Codex), and of course the OT itself is free. Is there a free webhelp plugin anywhere to the OT? I can't find one that looks viable.

Thanks!
Nancy


Re: ** SPAM scored: Med ** [dita-users] WebHelp on a shoestring? #DITA-OT

Niels Grundtvig Nielsen
 

XML Mind (DITA only edition) appears to offer a single-user licence for $175, and then you’d be kitted out to propose elegant WebHelp to more of your clients. Of course, in an ideal world the client would accept that their requirement needs the intersection of the skills you have and the software you don’t … but it’s been a lo-o-ong time since I had to do that sort of arm-wrestling. Good luck!

 

Niels Grundtvig Nielsen

technical author Worldline Terminals, Solutions and Services

Worldline Expert in technical communications

you know what you’re talking about – I can help you say it

3/5 – out of office Thursday and Friday

 

From: main@dita-users.groups.io [mailto:main@dita-users.groups.io] On Behalf Of Nancy Roberts
Sent: zondag 28 februari 2021 19:52
To: main@dita-users.groups.io
Subject: ** SPAM scored: Med ** [dita-users] WebHelp on a shoestring? #dita-ot

 

Caution! External email. Do not open attachments or click links, unless this email comes from a known sender and you know the content is safe.

Hi again,

I'm looking into providing webhelp for a single client I freelance for. What's the cheapest way to get webhelp output? Oxygen Editor offers a $200 personal license, which is still a lot for a single client. I've found a freeware editor (Codex), and of course the OT itself is free. Is there a free webhelp plugin anywhere to the OT? I can't find one that looks viable.

Thanks!
Nancy

Worldline and Ingenico are registered trademarks and trade names owned by the Worldline Group. This e-mail and any documents attached are confidential and intended solely for the addressee. If you are not the intended recipient of this e-mail, you are not authorized to copy, disclose, use or retain it. Please notify the sender immediately and delete this e-mail (including any attachments) from your systems. As e-mails may be intercepted, amended or lost, they are not secure. Worldline and its subsidiaries therefore cannot accept liability for any errors in their content. Although the Worldline Group endeavours to maintain a virus-free network, we do not warrant that this e-mail is virus-free and do not accept liability for any damages or losses resulting from any transmitted virus if any. The risks are deemed to be accepted by anyone who communicates with Worldline or its subsidiaries by e-mail.


Re: WebHelp on a shoestring? #dita-ot #DITA-OT

Mark Giffin
 

Do you need webhelp features like full-text search? That's the hardest thing to do yourself. What about giving them plain HTML5 output

On 2/28/2021 10:52 AM, Nancy Roberts wrote:
Hi again,

I'm looking into providing webhelp for a single client I freelance for. What's the cheapest way to get webhelp output? Oxygen Editor offers a $200 personal license, which is still a lot for a single client. I've found a freeware editor (Codex), and of course the OT itself is free. Is there a free webhelp plugin anywhere to the OT? I can't find one that looks viable.

Thanks!
Nancy


WebHelp on a shoestring? #dita-ot #DITA-OT

Nancy Roberts
 

Hi again,

I'm looking into providing webhelp for a single client I freelance for. What's the cheapest way to get webhelp output? Oxygen Editor offers a $200 personal license, which is still a lot for a single client. I've found a freeware editor (Codex), and of course the OT itself is free. Is there a free webhelp plugin anywhere to the OT? I can't find one that looks viable.

Thanks!
Nancy


Re: New installation of the DITA-OT #DITA-OT

Nancy Roberts
 

That worked - thank you! And thank you too, Alan!

Have a great evening.

Nancy


Re: New installation of the DITA-OT #DITA-OT

Alan Houser
 

Hi again,

How about ... in your Windows shell, change you current directory to the location of sequence.ditamap? (I usually work in a UNIX shell ... "cd" command. It may be "dir" in Windows). If you're using "--input=sequence.ditamap", the 'dita' command will look for the ditamap in the current directory. (Since your "PATH environment variable is set, your system should find the 'dita' command regardless of current directory).

Or try using the full path to the ditamap as an argument to --input: "--input=C:\Program Files\dita-ot-3.6\docsrc\samples\sequence.ditamp". Another possibility ... you may need to double each backslash character: "\\".

HTH!

-Alan

On 2/27/21 10:11 PM, Nancy Roberts wrote:
Whoops, I pasted the wrong example. Like I said, I'm good with GUI-based tools. I've never done anything serious with the command line. This is sort of a trial by fire.

So now my problem is the input path. I've tried every combination of .\ and ..\ that I can think of. I can't find the right combination to run the sample map provided in the OT. The map's path is C:\Program Files\dita-ot-3.6\docsrc\samples\sequence.ditamp. I set the PATH environment variable to C:\Program Files\dita-ot-3.6\bin.

How do I run this command? Running the suggested syntax gets me nowhere:
--input=sequence.ditamap --format=html5
Error: Failed to run pipeline: [DOTA069F][FATAL] Input file 'file:/C:/Program%20Files/dita-ot-3.6/sequence.ditamap' cannot be located or read. Ensure that file was specified properly and that you have permission to access it.

Adding some combination of .\ and ..\ makes it worse.
Help...

Thanks!
Nancy
-- 
Alan Houser
Group Wellesley, Inc.
Consultant and Trainer, Technical Publishing
arh on Twitter
412-450-0532


Re: New installation of the DITA-OT #DITA-OT

Dan Vint
 

I think you need to quote the path because of the space in "Program Files". Quote the whole path and I think it will work.



Sent from my Verizon, Samsung Galaxy smartphone


-------- Original message --------
From: Nancy Roberts <nanr93@...>
Date: 2/27/21 7:11 PM (GMT-08:00)
To: main@dita-users.groups.io
Subject: Re: [dita-users] New installation of the DITA-OT #DITA-OT

Whoops, I pasted the wrong example. Like I said, I'm good with GUI-based tools. I've never done anything serious with the command line. This is sort of a trial by fire.

So now my problem is the input path. I've tried every combination of .\ and ..\ that I can think of. I can't find the right combination to run the sample map provided in the OT. The map's path is C:\Program Files\dita-ot-3.6\docsrc\samples\sequence.ditamp. I set the PATH environment variable to C:\Program Files\dita-ot-3.6\bin.

How do I run this command? Running the suggested syntax gets me nowhere:
--input=sequence.ditamap --format=html5
Error: Failed to run pipeline: [DOTA069F][FATAL] Input file 'file:/C:/Program%20Files/dita-ot-3.6/sequence.ditamap' cannot be located or read. Ensure that file was specified properly and that you have permission to access it.

Adding some combination of .\ and ..\ makes it worse.
Help...

Thanks!
Nancy


Re: New installation of the DITA-OT #DITA-OT

Nancy Roberts
 

Whoops, I pasted the wrong example. Like I said, I'm good with GUI-based tools. I've never done anything serious with the command line. This is sort of a trial by fire.

So now my problem is the input path. I've tried every combination of .\ and ..\ that I can think of. I can't find the right combination to run the sample map provided in the OT. The map's path is C:\Program Files\dita-ot-3.6\docsrc\samples\sequence.ditamp. I set the PATH environment variable to C:\Program Files\dita-ot-3.6\bin.

How do I run this command? Running the suggested syntax gets me nowhere:
--input=sequence.ditamap --format=html5
Error: Failed to run pipeline: [DOTA069F][FATAL] Input file 'file:/C:/Program%20Files/dita-ot-3.6/sequence.ditamap' cannot be located or read. Ensure that file was specified properly and that you have permission to access it.

Adding some combination of .\ and ..\ makes it worse.
Help...

Thanks!
Nancy


Re: New installation of the DITA-OT #DITA-OT

Alan Houser
 

Hi,

It looks like you're missing the double-dash before "format"? And I suspect you want "--format=html5" (or xhtml).

HTH!

-Alan

On 2/27/21 2:50 PM, Nancy Roberts wrote:
Hi all,

I'm an experienced DITA user, but I've only ever used Oxygen or the Ixiasoft CMS to produce documentation for the company I work for. Now I've got a private client interested in HTML output of some sort (we'll probably settle on HTML5). I'm trying to put together an inexpensive DITA solution (read: free). I found and installed Codex, which seems promising. Then I installed the Adopt OpenJDK and the DITA-OT, v3.6. I set the PATH variable, in accordance with the installation instructions. I am able to run a bunch of commands, but I can't generate any output using the sample map (sequence.ditamap) and preinstalled plugins that come with the OT.

Here's what I'm getting:

C:\Users\nanr9>dita --input=sequence.ditamap format=dita
Error: Transformation type not defined
 
←[1mUsage←[0m:
  dita -i <file> -f <name> [options]
  dita --project=<file> [options]
 
←[1mSubcommands←[0m:
  deliverables                  Print list of deliverables in project file
  install                       Install or reload plug-ins
  plugins                       Print list of installed plug-ins
  transtypes                    Print list of installed transformation types (output formats)
  uninstall                     Remove and delete plug-in
  version                       Print version information and exit
 
  See 'dita <subcommand> --help' for details about a specific subcommand.
 
←[1mArguments←[0m:
  -i <file>, --input=<file>     Input file
  -f <name>, --format=<name>    Output format (transformation type)
  -p <file>, --project=<file>   Publish a project file with multiple deliverables
 
←[1mOptions←[0m:
  --filter=<files>              Filter and flagging files. This option can be passed multiple times.
  -h, --help                    Print help information
  -o <dir>, --output=<dir>      Output directory
  -r <file>, --resource=<file>  Additional input resources. This option can be passed multiple times.
 
See 'dita --help' for full list of options.

When I run transtypes, I can see both HTML5 and XHTML are installed:

C:\Users\nanr9>dita --transtypes
xhtml
eclipsehelp
html5
htmlhelp
dita
pdf
pdf2
markdown
markdown_github
       markdown_gitbook


What am I doing wrong?

Thanks!
Nancy
-- 
Alan Houser
Group Wellesley, Inc.
Consultant and Trainer, Technical Publishing
arh on Twitter
412-450-0532


Re: hide and seek

selvats@...
 

Please use the toc=no attribute on the topicref for the topic to hide it from the TOC.


New installation of the DITA-OT #DITA-OT

Nancy Roberts
 

Hi all,

I'm an experienced DITA user, but I've only ever used Oxygen or the Ixiasoft CMS to produce documentation for the company I work for. Now I've got a private client interested in HTML output of some sort (we'll probably settle on HTML5). I'm trying to put together an inexpensive DITA solution (read: free). I found and installed Codex, which seems promising. Then I installed the Adopt OpenJDK and the DITA-OT, v3.6. I set the PATH variable, in accordance with the installation instructions. I am able to run a bunch of commands, but I can't generate any output using the sample map (sequence.ditamap) and preinstalled plugins that come with the OT.

Here's what I'm getting:

C:\Users\nanr9>dita --input=sequence.ditamap format=dita
Error: Transformation type not defined
 
←[1mUsage←[0m:
  dita -i <file> -f <name> [options]
  dita --project=<file> [options]
 
←[1mSubcommands←[0m:
  deliverables                  Print list of deliverables in project file
  install                       Install or reload plug-ins
  plugins                       Print list of installed plug-ins
  transtypes                    Print list of installed transformation types (output formats)
  uninstall                     Remove and delete plug-in
  version                       Print version information and exit
 
  See 'dita <subcommand> --help' for details about a specific subcommand.
 
←[1mArguments←[0m:
  -i <file>, --input=<file>     Input file
  -f <name>, --format=<name>    Output format (transformation type)
  -p <file>, --project=<file>   Publish a project file with multiple deliverables
 
←[1mOptions←[0m:
  --filter=<files>              Filter and flagging files. This option can be passed multiple times.
  -h, --help                    Print help information
  -o <dir>, --output=<dir>      Output directory
  -r <file>, --resource=<file>  Additional input resources. This option can be passed multiple times.
 
See 'dita --help' for full list of options.

When I run transtypes, I can see both HTML5 and XHTML are installed:

C:\Users\nanr9>dita --transtypes
xhtml
eclipsehelp
html5
htmlhelp
dita
pdf
pdf2
markdown
markdown_github
       markdown_gitbook


What am I doing wrong?

Thanks!
Nancy


Re: Using conkeyref-push to replace one topic with another at the map level

Chris Papademetrious
 

Hi Julio, Radu,

Thanks for giving this some thought. This produced a different error:

[conref-push] [DOTJ043W][WARN] The conref push function is trying to replace an element that does not exist (element "#id3" in file "/tmp/temp20210226091132575/topic_3.dita").

so I filed a DITA-OT issue to reconcile the functionality against the spec:

Map-level conkeyref-push of a topic does not work #3711

Testcase provided with the issue, if you'd like to poke at it!

 - Chris


Re: Using conkeyref-push to replace one topic with another at the map level

Julio J Vazquez
 

I think Radu's syntax is the most correct, but more correct would be to use and use key#topicid.

Julio J. Vazquez


Re: Using conkeyref-push to replace one topic with another at the map level

Radu Coravu
 

Hi Chris,

This looks like a bug to me.

How about if you explicitly specify the topic ID when definining the "topic_2" key?

<topicref href="topic_2.dita#topicID" keys="topic_2"/>

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 2/25/21 19:16, Chris Papademetrious wrote:

Hi folks!

According to the DITA spec at

https://docs.oasis-open.org/dita/dita/v1.3/os/part2-tech-content/archSpec/base/conref-overview.html

a conref/conkeyref can target:

  • A referenced element within a DITA map
  • A referenced element within a DITA topic
  • An entire DITA map
  • An entire DITA topic

We have a need to replace a boilerplate topic in a reused map with a product-specific topic. I created the following test map (topics 1-3 would actually be in the reused map):

<?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>
    <title>Map</title>
    <topicref href="topic_2_replacement.dita" processing-role="resource-only"
        conkeyref="topic_2" conaction="pushreplace" />
    <topicref href="topic_1.dita" keys="topic_1"/>
    <topicref href="topic_2.dita" keys="topic_2"/>
    <topicref href="topic_3.dita" keys="topic_3"/>
</map>

but the DITA-OT issues the following error:

[conref-push] [DOTJ041E][ERROR] The attribute conref="topic_2.dita" uses invalid syntax. The value should contain '#' followed by a topic or map ID, optionally followed by '/elemID' for a sub-topic element.

It doesn't seem to want to operate on an entire topic. I was able to approximate the behavior by moving the pushes into the replacement topic <title> and <body> elements, but this is fragile and awkward.

Are entire-topic (and entire-map) operations not supported after all? Thanks in advance for any help!

 - Chris

  


Using conkeyref-push to replace one topic with another at the map level

Chris Papademetrious
 

Hi folks!

According to the DITA spec at

https://docs.oasis-open.org/dita/dita/v1.3/os/part2-tech-content/archSpec/base/conref-overview.html

a conref/conkeyref can target:

  • A referenced element within a DITA map
  • A referenced element within a DITA topic
  • An entire DITA map
  • An entire DITA topic

We have a need to replace a boilerplate topic in a reused map with a product-specific topic. I created the following test map (topics 1-3 would actually be in the reused map):

<?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>
    <title>Map</title>
    <topicref href="topic_2_replacement.dita" processing-role="resource-only"
        conkeyref="topic_2" conaction="pushreplace" />
    <topicref href="topic_1.dita" keys="topic_1"/>
    <topicref href="topic_2.dita" keys="topic_2"/>
    <topicref href="topic_3.dita" keys="topic_3"/>
</map>

but the DITA-OT issues the following error:

[conref-push] [DOTJ041E][ERROR] The attribute conref="topic_2.dita" uses invalid syntax. The value should contain '#' followed by a topic or map ID, optionally followed by '/elemID' for a sub-topic element.

It doesn't seem to want to operate on an entire topic. I was able to approximate the behavior by moving the pushes into the replacement topic <title> and <body> elements, but this is fragile and awkward.

Are entire-topic (and entire-map) operations not supported after all? Thanks in advance for any help!

 - Chris


Re: Multiple links to same topic #linking #PDF

mganir@...
 

Thanks Radu!


Re: hide and seek

Aaron Mehl
 

Thanks for all the suggestions, I haven't used index terms yet, I will look into it, and I am implementing the other ideas.
Aaron

On Wednesday, February 24, 2021, 09:21:37 AM EST, Dave C <dac.dave@...> wrote:


If you add an xref to the topic (like in a tip or something) but don't include the topic in the map the topic will be included in the webhelp output and the link will work, but it will not show up in navigation. The downside is that it will break the breaks-crumb navigation and the miniTOC. 

Dave C.

281 - 300 of 46324