Date   

Re: Are you using <data-about>?

Lionel Moizeau
 

Hi 
I do not, I was actually wondering what it was for...

Lionel Moizeau

On Tue, Sep 1, 2020 at 11:24 PM Kristen James Eberlein <kris@...> wrote:

At today's DITA Technical Committee meeting, we discussed the possibility of removing <data-about> from DITA 2.0. The rationale for removal is:

  • The spec element-reference topic is extremely convoluted. Neither spec editors (Robert Anderson and I) has been able to rework it and make it comprehensible.
  • There is nothing done with <data-about> that cannot be done with <data>.
  • We suspect that the element is little used -- and if used, is usually misused.

So, our query to the larger DITA-using community:

  • Does your implementation use the <data-about> element?
  • (If the <data-about> element is used) What are the use cases for <data-about>? Please note that these should be actual, not theoretical.

As always, thanks for your participation in the dita-users list.

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


Are you using <data-about>?

Kristen James Eberlein
 

At today's DITA Technical Committee meeting, we discussed the possibility of removing <data-about> from DITA 2.0. The rationale for removal is:

  • The spec element-reference topic is extremely convoluted. Neither spec editors (Robert Anderson and I) has been able to rework it and make it comprehensible.
  • There is nothing done with <data-about> that cannot be done with <data>.
  • We suspect that the element is little used -- and if used, is usually misused.

So, our query to the larger DITA-using community:

  • Does your implementation use the <data-about> element?
  • (If the <data-about> element is used) What are the use cases for <data-about>? Please note that these should be actual, not theoretical.

As always, thanks for your participation in the dita-users list.

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


Re: proper way to do trouble-shooting containing console commands

 

Tag anything that a user types with <userinput>.  
Grant

On Tue, Sep 1, 2020 at 4:36 AM Weiwu Zhang via groups.io <weiwu.zhang=alphawallet.com@groups.io> wrote:

Hi just made my first troubleshoot guide that instructs the user to type a
few commands to find the problem.

I've got a dilemma here:

- if I put the command-to-type in <cmdname> I feel wrong because <cmdname>
is for the name of the command, not the full command.

- if I put the command-to-type inside the <codeblock> I feel wrong too
since that is included in the <stepresult> but it's not part of the
result.

What would you normally do?

Thanks!

--

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE troubleshooting PUBLIC "-//OASIS//DTD DITA Troubleshooting//EN" "troubleshooting.dtd">
<troubleshooting id="troubleshooting_signing">
     <title>Troubleshooting Signing</title>
     <troublebody>
         <condition>
             <title>Wrong key used for signing</title>
             <p>Error on the singing</p>
         </condition>
         <troubleSolution>
             <cause>
                 <title>Cause</title>
                 <p>The signing key doesn't match the certificate.</p>
             </cause>
             <remedy>
                 <title>Remedy</title>
                 <responsibleParty>Token Issuer</responsibleParty>
                 <steps>
                     <step>
                         <cmd>Use <cmdname>openssl ec -in key -pubout</cmdname> command (replace
                                 <codeph>key</codeph> with your actual key file) to generate the
                             public key from the private key. Run the following command:</cmd>
                         <stepresult>
                             <codeblock>read EC key
writing EC key
-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwXfiK2ao/T8EDv02rr1a0xZYKkox
v3FGDltKFLsZNIyTUo5RAhFh8RXy8/hqSlozGfd3pOx/70LeGzbWd/ExQg==
-----END PUBLIC KEY-----</codeblock>
                         </stepresult>
                     </step>

                     <step>
                         <cmd>Use <cmdname>openssl x509 -pubkey -in crt</cmdname> command (replace
                                 <codeph>crt</codeph> with your actual certificate file) to show the
                             public key in the certificate's subject:</cmd>
                         <stepresult>
                             <codeblock>$
-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwXfiK2ao/T8EDv02rr1a0xZYKkox
v3FGDltKFLsZNIyTUo5RAhFh8RXy8/hqSlozGfd3pOx/70LeGzbWd/ExQg==
-----END PUBLIC KEY-----</codeblock>
                         </stepresult>
                     </step>
                     <step>
                         <cmd>Check if the public key generated from the private key is the same as
                             the public key in the certificate's subject. If they are not the same,
                             your key doesn't match your certificate. Try to obtain the right key /
                             certificate.</cmd>
                     </step>
                 </steps>
             </remedy>
         </troubleSolution>
     </troublebody>
</troubleshooting>




error in producing troff output

Weiwu Zhang
 

Following the guide from here:

https://www.dita-ot.org/plugins#!org.dita.troff

I installed the plugin on dita-ot 3.6

$ dita install org.dita.troff
Added org.dita.troff

and attempted to make troff out of a file:

$ dita --input=a_topic.dita --format=troff
Error: Includesfile /tmp/temp20200901230030922/${fullditatopicfile} not found.

No luck replacing the dita file with a ditamap either. It is from a project which already works with other output (html5/pdf).

Any hint how to proceed on / file bug?

Regards


Re: proper way to do trouble-shooting containing console commands

Kristen James Eberlein
 

Use <userinput> for a command that the user should type.

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)

On 9/1/2020 6:35 AM, Weiwu Zhang via groups.io wrote:

Hi just made my first troubleshoot guide that instructs the user to type a few commands to find the problem.

I've got a dilemma here:

- if I put the command-to-type in <cmdname> I feel wrong because <cmdname> is for the name of the command, not the full command.

- if I put the command-to-type inside the <codeblock> I feel wrong too since that is included in the <stepresult> but it's not part of the result.

What would you normally do?

Thanks!

--

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE troubleshooting PUBLIC "-//OASIS//DTD DITA Troubleshooting//EN" "troubleshooting.dtd">
<troubleshooting id="troubleshooting_signing">
    <title>Troubleshooting Signing</title>
    <troublebody>
        <condition>
            <title>Wrong key used for signing</title>
            <p>Error on the singing</p>
        </condition>
        <troubleSolution>
            <cause>
                <title>Cause</title>
                <p>The signing key doesn't match the certificate.</p>
            </cause>
            <remedy>
                <title>Remedy</title>
                <responsibleParty>Token Issuer</responsibleParty>
                <steps>
                    <step>
                        <cmd>Use <cmdname>openssl ec -in key -pubout</cmdname> command (replace
                                <codeph>key</codeph> with your actual key file) to generate the
                            public key from the private key. Run the following command:</cmd>
                        <stepresult>
                            <codeblock>read EC key
writing EC key
-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwXfiK2ao/T8EDv02rr1a0xZYKkox
v3FGDltKFLsZNIyTUo5RAhFh8RXy8/hqSlozGfd3pOx/70LeGzbWd/ExQg==
-----END PUBLIC KEY-----</codeblock>
                        </stepresult>
                    </step>

                    <step>
                        <cmd>Use <cmdname>openssl x509 -pubkey -in crt</cmdname> command (replace
                                <codeph>crt</codeph> with your actual certificate file) to show the
                            public key in the certificate's subject:</cmd>
                        <stepresult>
                            <codeblock>$ -----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwXfiK2ao/T8EDv02rr1a0xZYKkox
v3FGDltKFLsZNIyTUo5RAhFh8RXy8/hqSlozGfd3pOx/70LeGzbWd/ExQg==
-----END PUBLIC KEY-----</codeblock>
                        </stepresult>
                    </step>
                    <step>
                        <cmd>Check if the public key generated from the private key is the same as
                            the public key in the certificate's subject. If they are not the same,
                            your key doesn't match your certificate. Try to obtain the right key /
                            certificate.</cmd>
                    </step>
                </steps>
            </remedy>
        </troubleSolution>
    </troublebody>
</troubleshooting>




proper way to do trouble-shooting containing console commands

Weiwu Zhang <weiwu.zhang@...>
 

Hi just made my first troubleshoot guide that instructs the user to type a few commands to find the problem.

I've got a dilemma here:

- if I put the command-to-type in <cmdname> I feel wrong because <cmdname> is for the name of the command, not the full command.

- if I put the command-to-type inside the <codeblock> I feel wrong too since that is included in the <stepresult> but it's not part of the result.

What would you normally do?

Thanks!

--

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE troubleshooting PUBLIC "-//OASIS//DTD DITA Troubleshooting//EN" "troubleshooting.dtd">
<troubleshooting id="troubleshooting_signing">
<title>Troubleshooting Signing</title>
<troublebody>
<condition>
<title>Wrong key used for signing</title>
<p>Error on the singing</p>
</condition>
<troubleSolution>
<cause>
<title>Cause</title>
<p>The signing key doesn't match the certificate.</p>
</cause>
<remedy>
<title>Remedy</title>
<responsibleParty>Token Issuer</responsibleParty>
<steps>
<step>
<cmd>Use <cmdname>openssl ec -in key -pubout</cmdname> command (replace
<codeph>key</codeph> with your actual key file) to generate the
public key from the private key. Run the following command:</cmd>
<stepresult>
<codeblock>read EC key
writing EC key
-----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwXfiK2ao/T8EDv02rr1a0xZYKkox
v3FGDltKFLsZNIyTUo5RAhFh8RXy8/hqSlozGfd3pOx/70LeGzbWd/ExQg==
-----END PUBLIC KEY-----</codeblock>
</stepresult>
</step>

<step>
<cmd>Use <cmdname>openssl x509 -pubkey -in crt</cmdname> command (replace
<codeph>crt</codeph> with your actual certificate file) to show the
public key in the certificate's subject:</cmd>
<stepresult>
<codeblock>$ -----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwXfiK2ao/T8EDv02rr1a0xZYKkox
v3FGDltKFLsZNIyTUo5RAhFh8RXy8/hqSlozGfd3pOx/70LeGzbWd/ExQg==
-----END PUBLIC KEY-----</codeblock>
</stepresult>
</step>
<step>
<cmd>Check if the public key generated from the private key is the same as
the public key in the certificate's subject. If they are not the same,
your key doesn't match your certificate. Try to obtain the right key /
certificate.</cmd>
</step>
</steps>
</remedy>
</troubleSolution>
</troublebody>
</troubleshooting>


Re: How to constraint elements of Standard Highlighting domain module #constraints

ekimber@contrext.com
 

If you simply want to disallow the use of specific elements from a domain you can do this in the DTD shell--no need for a separate constraint module.

But note that this does require that you have custom DTD shells (see https://www.xiruss.org/tutorials/dita-specialization/, in particular, Chapter 3, Document Type Shell tutorial).

In the shell DTD you "integrate" domain using domain-integration parameter entities, i.e., (here take from the basetopic.dtd but it will be similar in any of the OASIS-provided DTD shells):

<!-- ============================================================= -->
<!-- DOMAIN EXTENSIONS -->
<!-- ============================================================= -->

...

<!ENTITY % ph "ph |
%hi-d-ph;
">


Here "%hi-d-ph;" is a reference to a parameter entity that includes all the element types from the Highlight domain (base/dtd/highlightDomain.ent):

<!ENTITY % hi-d-ph
"b |
i |
line-through |
overline |
sup |
sub |
tt |
u"
That has the effect of allowing all the elements to occur wherever <ph> is allowed.

This entity, %hi-d-ph, is the "domain integration parameter entity".

Instead of referring to %hi-d-ph in the domain integration parameter entity you can simply refer to the element types you want to allow;

<!-- ============================================================= -->
<!-- DOMAIN EXTENSIONS -->
<!-- ============================================================= -->

...

<!ENTITY % ph "ph |
sup |
sub
">

This is a constraint and, per DITA 1.x rules, should be declared in the @domains attribute just as you would declare a constraint module, but we're removing the @domains attribute in DITA 2.0 and as far as I know no tool will complain that you didn't declare this constraint.

Note that you need to define this constraint in the shell DTD for each topic type you're using.

Cheers,

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


On 8/31/20, 3:21 AM, "Meghana" <main@dita-users.groups.io on behalf of meghan25pathroju@gmail.com> wrote:

Hello Team,
Good Morning!

I am currently working on example:2.5.5.6.3 constrain a domain module. referring to http://docs.oasis-open.org/

use case :The requirement is to apply constraints on dita elements of highlighting domain module and remove them from the DTD files reason being business doesn't want to give access to all the dita elements provided by web-editor,basically limiting element choices for authors.
example: An information architect wants to use only a subset of the elements defined in the highlighting domain. She wants to use <sup>, <sup>but not <b> ,<i>,<line-through>, <overline>, <tt> .She wants to integrate this constraint into the DTD's / document-type shell for tasks


Reference I followed to achieve this: http://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/archSpec/base/example-contraints-subset-domain.html


1. I am not trying to create new DTD schema instead I would like to make use of standard or default highlighting domain module provided by OASIS (//OASIS//ENTITIES DITA 1.3 Highlight Domain//EN" "../../base/dtd/highlightDomain.ent) to constraint <b> ,<i>,<line-through>, <overline>, <tt> and allow <sub>,<sup> elements.
2. The example in document is intended for the users who has custom DTD schema i.e ACME(//ACME//ENTITIES DITA Highlighting Domain Constraint//EN" "acme-HighlightingDomainConstraint.mod")and they would like to restrict the elements from the custom highlighting domain.My requirement is different from the example in the document.
3. I feel the information provided in the document is insufficient and targets the audience who works on custom DTD schema's and it is difficult for the DITA newbie's like me to understand that high level example.Please,guide me on how to achieve above mentioned use case.Please,throw some light on the different ways to achieve this use case.

Thanks,
Meghana Pathroju.


Re: How to constraint elements of Standard Highlighting domain module #constraints

Kristen James Eberlein
 

Hi, Meghana.

I understand your use case well. The problem here is that constraints ONLY can be applied if you are using company-specific document-type shells (DTDs). You CANNOT apply constraints to the out-of-the-box OASIS DTDs.

Depending on the editor that you authors are using, you might be able to hide elements from the authors. This is certainly true of the desktop version of Oxygen XML Editor. It does require creating a custom framework for Oxygen installations.

I am sorry that you found the example in the spec to be difficult. As one of the spec editors, I can reinforce your sense that the target audience is DITA practioners who develop company-specific DTDs, constraints, and specialization -- as well as engineers who design and build DITA processors. The target audience for the spec is not people new to DITA.

While there are now quite a few good books that are resources for people new to DITA, I do not think that any of them delve into the more technical aspects of implementing DITA.

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)

On 8/31/2020 4:21 AM, Meghana wrote:
Hello Team,
Good Morning!

I am currently working on example:2.5.5.6.3 constrain a domain module. referring to  http://docs.oasis-open.org/

use case :The requirement is to apply constraints on dita elements of highlighting domain module and remove them from the DTD files reason being business doesn't want to give access to all the dita elements provided by web-editor,basically limiting element choices for authors.

example
: An information architect wants to use only a subset of the elements defined in the highlighting domain. She wants to use  <sup>, <sup>but not <b> ,<i>,<line-through>, <overline>, <tt> .She wants to integrate this constraint into the DTD's / document-type shell for tasks


  1. I am not trying to create new DTD schema instead I would like to make use of standard or default highlighting domain module provided by OASIS (//OASIS//ENTITIES DITA 1.3 Highlight Domain//EN"  "../../base/dtd/highlightDomain.ent) to constraint  <b> ,<i>,<line-through>, <overline>, <tt> and allow <sub>,<sup> elements.
  2. The example in document is intended for the users who has custom DTD schema i.e ACME(//ACME//ENTITIES DITA Highlighting Domain Constraint//EN" "acme-HighlightingDomainConstraint.mod")and they would like to restrict the elements from the custom highlighting domain.My requirement is different from the example in the document.
  3. I feel the information provided in the document is insufficient and targets the audience who works on custom DTD schema's and it is difficult for the DITA newbie's like me to understand that high level example.Please,guide me on how to achieve above mentioned use case.Please,throw some light on the different ways to achieve this use case.
Thanks,
Meghana Pathroju.


Re: Super Health Secrets

Kristen James Eberlein
 

This member now has been banned.

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)

On 8/31/2020 8:14 AM, Dora Tamilta via groups.io wrote:
When asked about his secret of staying young, Dick Clark replied, ” it’s simple. Pick your parents carefully. “
 
Obviously, you can’t pick your parents, otherwise Ozzie and Harriet would have had thousands of children. However, who your parents are can have a huge impact on how long you live. Diseases that can cut your life short, like heart disease, Alzheimer’s, and most types of cancers, have a strong genetic connection. 
Here is a detailed article that explains how you can avoid or reduce the impact these deadly diseases that you might have inherited.
 


How to constraint elements of Standard Highlighting domain module #constraints

 

Hello Team,
Good Morning!

I am currently working on example:2.5.5.6.3 constrain a domain module. referring to  http://docs.oasis-open.org/

use case :The requirement is to apply constraints on dita elements of highlighting domain module and remove them from the DTD files reason being business doesn't want to give access to all the dita elements provided by web-editor,basically limiting element choices for authors.

example
: An information architect wants to use only a subset of the elements defined in the highlighting domain. She wants to use  <sup>, <sup>but not <b> ,<i>,<line-through>, <overline>, <tt> .She wants to integrate this constraint into the DTD's / document-type shell for tasks


  1. I am not trying to create new DTD schema instead I would like to make use of standard or default highlighting domain module provided by OASIS (//OASIS//ENTITIES DITA 1.3 Highlight Domain//EN"  "../../base/dtd/highlightDomain.ent) to constraint  <b> ,<i>,<line-through>, <overline>, <tt> and allow <sub>,<sup> elements.
  2. The example in document is intended for the users who has custom DTD schema i.e ACME(//ACME//ENTITIES DITA Highlighting Domain Constraint//EN" "acme-HighlightingDomainConstraint.mod")and they would like to restrict the elements from the custom highlighting domain.My requirement is different from the example in the document.
  3. I feel the information provided in the document is insufficient and targets the audience who works on custom DTD schema's and it is difficult for the DITA newbie's like me to understand that high level example.Please,guide me on how to achieve above mentioned use case.Please,throw some light on the different ways to achieve this use case.
Thanks,
Meghana Pathroju.


Super Health Secrets

Dora Tamilta <doratamilta@...>
 

When asked about his secret of staying young, Dick Clark replied, ” it’s simple. Pick your parents carefully. “
 
Obviously, you can’t pick your parents, otherwise Ozzie and Harriet would have had thousands of children. However, who your parents are can have a huge impact on how long you live. Diseases that can cut your life short, like heart disease, Alzheimer’s, and most types of cancers, have a strong genetic connection. 
Here is a detailed article that explains how you can avoid or reduce the impact these deadly diseases that you might have inherited.
 


Re: Can LwDITA MDITA format transclude "normal" dita content?

Radu Coravu
 

Hi Weiwu,

Your markdown file seems to be referenced like a lightweight DITA topic in the DITA Map:

<topicref href="intros/token-negotiation.md" format="mdita"/>

I'm attaching the LightWeight DITA equivalent topic that the DITA Open Toolkit publishing engine dynamically creates based on it.

If you open it in a DITA editing tool and validate it, there are about 4 problems with it:

1) The element <div> is not accepted in a Lightweight DITA topic. Only the following elements are allowed:

http://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.html#concept_ig4_cfb_dy

2) The @conref element is allowed only on these Lightweight DITA elements:

http://docs.oasis-open.org/dita/LwDITA/v1.0/cnprd01/LwDITA-v1.0-cnprd01.html#ariaid-title15

3) The @type element is not allowed on the <div> element.

4) When you conref in a DITA topic you need to conref to an equivalent DITA element from the target topic. So a DITA <div> may conref to another <div> located in another DITA topic, not to a <concept> element. Like in the example from the specification:

 
<!DOCTYPE html>
<html>
  <title>Low-Power Networking</title>   
  <article id="low-power">
    <h1>Low-Power Networking</h1> 
    <p>Your <span data-keyref="product-name" /> operates at a low level of networking power but can successfully connect at long distances because they can send information from light bulb to light bulb.</p>
<p data-conref="bulbs-to-groups.dita#bulbs-to-groups/assign-disclaimer" />
    <p id="disconnect-warning" class="note">Even in low power networks, be sure to disconnect all devices before performing maintenance tasks.</p>
  </article>
</html>
there is an HTML <p> element pointing to a DITA <p> located in  "bulbs-to-groups.dita". The <p> would not be able to point to an entire <concept>.

Regards,
Radu
Radu Coravu
Oxygen XML Editor
On 8/31/20 5:24 AM, Weiwu Zhang via groups.io wrote:

I thought the answer was yes, but then I have this in a MDITA file†:

   The issuer defines how each token is used or interpreted through the
   following negotiation methods:

   <div data-conref="../TokenNegotiation.dita#concept_jrl_h5q_4mb" type="dita" />

Which gives me this error:

   [conref] file:/home/a/DitaProjects/TokenScript-Documents/intros/token-negotiation.md:578:34: [DOTX010E][ERROR]: Unable to find target for conref="../TokenNegotiation.dita#concept_jrl_h5q_4mb".

Troubleshooting:

1. Verified that the target "../TokenNegotiation.dita#concept_jrl_h5q_4mb" exists as a correct DITA 1.3 file. Source: https://github.com/AlphaWallet/TokenScript-Documents/blob/intro-articles/TokenNegotiation.dita

2. Verify that the source md works if without this offending line:

$ dita --input=Guides.ditamap --format=html5
(no error in output)


Which lead me to think maybe it's because conref doesn't work if the target is in DITA format while the reference happens in a md file†. Is it the case?

Thanks!

Weiwu Z.

https://github.com/AlphaWallet/TokenScript-Documents/blob/intro-articles/intros/token-negotiation.md





  


Can LwDITA MDITA format transclude "normal" dita content?

Weiwu Zhang <weiwu.zhang@...>
 

I thought the answer was yes, but then I have this in a MDITA file†:

The issuer defines how each token is used or interpreted through the
following negotiation methods:

<div data-conref="../TokenNegotiation.dita#concept_jrl_h5q_4mb" type="dita" />

Which gives me this error:

[conref] file:/home/a/DitaProjects/TokenScript-Documents/intros/token-negotiation.md:578:34: [DOTX010E][ERROR]: Unable to find target for conref="../TokenNegotiation.dita#concept_jrl_h5q_4mb".

Troubleshooting:

1. Verified that the target "../TokenNegotiation.dita#concept_jrl_h5q_4mb" exists as a correct DITA 1.3 file. Source: https://github.com/AlphaWallet/TokenScript-Documents/blob/intro-articles/TokenNegotiation.dita

2. Verify that the source md works if without this offending line:

$ dita --input=Guides.ditamap --format=html5
(no error in output)


Which lead me to think maybe it's because conref doesn't work if the target is in DITA format while the reference happens in a md file†. Is it the case?

Thanks!

Weiwu Z.

https://github.com/AlphaWallet/TokenScript-Documents/blob/intro-articles/intros/token-negotiation.md


Re: How to insert a picture into an HTML page so that it is not a separate file #HTML5

Jarno Elovirta
 

Hi,

If your images are in SVG format, a plugin could embed them directly into HTML. I’ve been meaning to add this as a built-in feature in DITA-OT. That you can either inline or extract all SVG images. The same would apply to MathML.

For binary image formats you need Base64 encoding in data URL.

J

--
Sent from a mobile device.

On 28. Aug 2020, at 7.40, Radu Coravu <radu_coravu@...> wrote:



Hi Carole,

I wanted to do something like this at some point but I never got around to it. A small DITA OT plugin with a custom Java extension could probably embed images directly in the HTML content.

Or you could maybe do that after the HTML files are produced, I googled for "embed image html command line github" and there seem to be a couple of GitHub projects which claim to do that.

Regards,
Radu
Radu Coravu
Oxygen XML Editor
On 8/27/20 4:06 PM, carole.c.girard@... wrote:
Has anyone tried to make the dita-ot do that? It works  if I do it manually, but for obvious reasons, we want to automate it so that when we generate HTML5 with the dita-ot, the HTML files include the images.


https://www.thesitewizard.com/html-tutorial/embed-images-with-data-urls.shtml
https://en.wikipedia.org/wiki/Base64#HTML

thanks


[ANN] Release of XMLmind XSL-FO Converter v6.3

Hussein Shafie
 

Release of XMLmind XSL-FO Converter v6.3. Highlights:

- XMLmind XSL-FO Converter engine:

* It is now possible to add metadata (e.g. the usual author, title, date, etc, but also custom metadata) to the documents created by XFC. (XFC equivalent of MS-Word "File|Info|Properties, Advanced Properties".)

* It is now possible to control the type of changes which can be made to the documents created by XFC. (XFC equivalent of MS-Word "File|Info|Protect Document, Restrict Editing".) For example, XFC can now generate a DOCX file which cannot be modified at all, unless the user types a password.

- Updated many software components in XMLmind XSL Utility and XMLmind XSL Server (ditac, Saxon, Batik, FOP, etc).

More information: https://www.xmlmind.com/foconverter/changes.html

---------------------------------
What is XMLmind XSL-FO Converter?
---------------------------------

XMLmind XSL-FO Converter is an XSL-FO processor similar to Apache FOP, RenderX XEP or Antenna House XSL Formatter, except that it generates RTF, WML, ODT and DOCX file formats rather than PDF.

More importantly, this commercial product comes with a handy desktop application called "XMLmind XSL Utility" (https://www.xmlmind.com/foconverter/xsl_utility.html) which makes it easy converting DITA, DocBook, XHTML and XSL-FO documents to a variety of formats (PDF, RTF, WML, ODT, DOCX, HTML, EPUB, Web Help, etc).

XMLmind XSL Utility also makes it easy customizing the deliverables it generates (PDF, DOCX, EPUB, Web Help, etc) and this, without modifying configuration files by hand and without prior knowledge of XSLT. See https://www.xmlmind.com/foconverter/_distrib/xslutil/doc/help/com.xmlmind.xslutil.ConversionEditor.html#customizing_xslt

Home page: https://www.xmlmind.com/foconverter/


Re: How to insert a picture into an HTML page so that it is not a separate file #HTML5

Radu Coravu
 

Hi Carole,

I wanted to do something like this at some point but I never got around to it. A small DITA OT plugin with a custom Java extension could probably embed images directly in the HTML content.

Or you could maybe do that after the HTML files are produced, I googled for "embed image html command line github" and there seem to be a couple of GitHub projects which claim to do that.

Regards,
Radu
Radu Coravu
Oxygen XML Editor
On 8/27/20 4:06 PM, carole.c.girard@... wrote:

Has anyone tried to make the dita-ot do that? It works  if I do it manually, but for obvious reasons, we want to automate it so that when we generate HTML5 with the dita-ot, the HTML files include the images.


https://www.thesitewizard.com/html-tutorial/embed-images-with-data-urls.shtml
https://en.wikipedia.org/wiki/Base64#HTML

thanks


[ann][webinar] Why technical comprehension improves when you add the A to #STEAM with Kylie Jacobsen #Room42 Sept 2nd @ 15:30 UTC

Liz Fraley
 

Title: Why technical comprehension improves when you add the A to #STEAM

When: Wednesday, Sept 2nd @ (8:30 LAX | 11:30 NYC | 16:30 LON | 20:00 BLR)

Register: 
http://bit.ly/room42-202008-jacobsen

Description:

Kylie Jacobsen will be In The Room!

Technical Communicators make the complex comprehendible. When it comes to creating training and instruction materials, addressing the learner’s ability to grasp advanced concepts is critical for instructional designers. A recent longitudinal study of students in reading and writing mathematical arguments suggests that input from Arts & Humanities professionals positively impacted performance.

This research can benefit practitioners in the field developing all forms of instruction. If you have a “How To” anywhere in your sphere then this chat is for you. In this episode of Room 42, we discuss how expanding the sphere of collaboration between STEAM professionals improves training and instruction materials and boosts comprehension of complex material.


Kylie M. Jacobsen is an Assistant Professor of Writing at Grand Valley State University. Her research focuses on user experience research methods in Science, Technology, Engineering, Arts & Humanities, and Mathematics (STEAM) environments, specifically analyzing the emotional journey of learning.


-:-

The Room 42 is brought to you by Single-Sourcing Solutions. Learn more: http://room42.single-sourcing.com

Register: http://bit.ly/room42-202008-jacobsen



Re: Dita to Confluence #content-delivery

carole.c.girard@...
 

Hi,

yes I saw the posts that suggested to use word. But being allergic to Word 8-)  it did not seem like a good option. the true reason is that we already support Dita, PDF and HTML5 for our existing documentation. WE just did not want to add another format.

The approach that we will use, until there is a true Dita to confluence plugin, is as follows

Generate our dita files in HTML5 (which are stored in Bitbucket)
Use the Bob Swift HTML plugin to  link our html files stored on Bitbucket.
For the images, because this is one thing that does not work properly, we insert them in the dita as a URL pointing to bitbucket.

This way, when the file is updated, it is automatically also updated in Confluence, where ever it is used.

We are now looking for a way to embed the image in the HTML because we don't want to expose our Stash URL, but this is the topic of another post.

kind regards


How to insert a picture into an HTML page so that it is not a separate file #HTML5

carole.c.girard@...
 

Has anyone tried to make the dita-ot do that? It works  if I do it manually, but for obvious reasons, we want to automate it so that when we generate HTML5 with the dita-ot, the HTML files include the images.


https://www.thesitewizard.com/html-tutorial/embed-images-with-data-urls.shtml
https://en.wikipedia.org/wiki/Base64#HTML

thanks


Re: keyref and conkeyref best practice and processing flow

Dan Vint
 

This response is not exactly correct. Something else is going on. I thought local was in the processing-role but that is in scope. Processing-role isn’t defined and is supposed to default to resource-only. I’m still researching what is going on.

 

 

 

From: main@dita-users.groups.io <main@dita-users.groups.io> On Behalf Of Dan Vint
Sent: Tuesday, August 25, 2020 3:39 PM
To: main@dita-users.groups.io; dita-users@groups.io
Cc: dvint@...
Subject: Re: [dita-users] keyref and conkeyref best practice and processing flow

 

Thanks for the pointer. I hadn't paid attention to how our ccms created the system generated keys were defined. It turns out they use local. I'm asking them why as even without this issue, resource-only seems to be the correct choice.

 

 

 

Sent from my Verizon, Samsung Galaxy smartphone

 

 

-------- Original message --------

From: Radu Coravu <radu_coravu@...>

Date: 8/23/20 10:47 PM (GMT-08:00)

Subject: Re: [dita-users] keyref and conkeyref best practice and processing flow

 

Hi Dan,

This should work. Please make sure that the topic inside which that
reused <p> element is located is referenced in the DITA Map as a
topicref with the "processing-role='resource-only'" attribute set on it:

https://github.com/dita-ot/dita-ot/issues/3546

If that did not help maybe you can give us more details like:

1) The DITA OT version you are using.

2) The output format you are publishing to.

3) Attach a small sample DITA project exemplifying the problem.

Regards,
Radu

Radu Coravu
Oxygen XML Editor

On 8/21/20 7:57 PM, Dan Vint wrote:
> I've been googling around for information on using keyref and
> conkeyref and not finding confirmation for something I thought I saw.
>
> I believe there is a recommendation (maybe requirement) that you can't
> nest these proceses. My testing seems to say it isn't supported, but
> maybe there is a feature I've not setup properly.
>
> We are trying to build a para that will be keyconref'd into a variety
> of locations. In this para we are also trying to use variables for the
> product names that are defined with keys.
>
> I've done the following:
> - confirmed that copying the para into the referencing topic allows
> the product name variable to work - so that key is configured properly
> - conkeyrefing the para in, the product variable is not resolved. I
> don't even get a message in the OT log that indicates it is being seen.
>
> I'm torn between saying this is a useful feature to have if it isn't
> supported, but on the other hand I can see where it might cause an
> infinite loop if these are allowed to nest.
>
> I'm mainly just trying to confirm that this is the way it is and that
> I haven't missed something.
>
> thanks
> ..dan
>
>
>



481 - 500 of 46224