Re: [oXygen-user] Best practices ways to override default oXygen Web Help processing

2019-12-10 Thread Oxygen XML Editor Support (Radu Pisoi) 

Hello,

As a general rule, it is recommended to keep all changes outside the 
WebHelp plugin. This allows you to easily upgrade to a new WebHelp 
distribution.


The following customization methods are available:

1. Create a WebHelp publishing template

A publishing template It is a self-contained customization package 
stored as a ZIP archive or folder that can easily be shared with others. 
It provides the primary method for customizing the output allowing you to:

*  Customize various aspects of the output through simple CSS styling.
* Extend the default processing by specifying one or more XSLT extension 
points.

* Specify one or more transformation parameters to customize the output.

More information is available in our documentation 
 
or video presentation .


2. Create DITA-OT extension plugin

This method allows you to use one of WebHelp XSLT extension points 
 
and it is preferable to use if you want to affect all WebHelp 
transformations.


Regarding to your questions to change generated text for task topic, the 
single available option is to create a DITA-OT extension plugin.


If I want to change the task labels that are used when the 
arg.gen.task.lbl parameter is specified, how do I accomplish this?
Please see the Modifying the Existing Strings 
 
procedure from our manual for this task.



If I want to ensure that a task label is generated for the 
 element, how do I accomplish this?
For the elements that have not associated a label in the 'strings' 
files, like  element, you need also to contribute 
an XSLT template that lookup in the string files.


mode="dita2html:section-heading">

    
    
    
    select="'task_tasktroubleshooting'"/>

    
    
    
    
The XSLT stylesheet can be contributed using the /dita.xsl.html5/ XSLT 
extension point:






Regards,

Radu
--
Radu Pisoi
  XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com

On 12/10/2019 5:56 AM, Kristen James Eberlein wrote:


I have questions about the best (and best practices) way to override 
default Web Help processing.


  * If I want to change the task labels that are used when the
arg.gen.task.lbl parameter is specified, how do I accomplish this?
  * If I want to ensure that a task label is generated for the
 element, how do I accomplish this?

I know how to effect these changes in a standard DITA-OT plug-in, but 
I am not sure how best to override the logic for oXygen Web Help. Can 
this be done in a Web Help template, or do I need to create a DITA-OT 
plug-in?


For this client, I want to keep everything as simple and modular as I 
can, to make moving to new versions of oXygen possible.  (I am in the 
midst of unraveling all the many changes that they hacked into oXygen 
plug-ins ...)


--
Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)


___
oXygen-user mailing list
oXygen-user@oxygenxml.com
https://www.oxygenxml.com/mailman/listinfo/oxygen-user
___
oXygen-user mailing list
oXygen-user@oxygenxml.com
https://www.oxygenxml.com/mailman/listinfo/oxygen-user

Re: [oXygen-user] Questions about spell checking

2019-12-10 Thread Kristen James Eberlein 
Thanks, Radu. Some of the content comes from outside the company, and it 
likely will never be correctly tagged.


Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)

On 12/10/2019 5:27 AM, Oxygen XML Editor Support (Radu Coravu) wrote:

Hi Kris,

Thanks for the feedback, I will add an internal issue to consider 
adding more settings for ignoring various constructs when the spell 
check is performed.
How about if the end users wrap these particular identifiers in some 
specific DITA inline element like  and you instruct the spell 
checker to ignore all code phrases when spell checking?


Regards,
Radu

Radu Coravu
 XML Editor
http://www.oxygenxml.com

On 12/9/2019 6:27 PM, Kristen James Eberlein wrote:
I'm working with a client to get rid of spelling errors in their 
content. After making changes to Spell check configuration and then 
to the DITA source, the errors have moved from over 10,000 to under 400.


I was glad to see that I could configure Spell check to ignore words 
with digits and mixed-case words.


*A question:* Can I configure some additional options, for example, 
to ignore words that contain an underscore? words that contain a period?


--
Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)


___
oXygen-user mailing list
oXygen-user@oxygenxml.com
https://www.oxygenxml.com/mailman/listinfo/oxygen-user


___
oXygen-user mailing list
oXygen-user@oxygenxml.com
https://www.oxygenxml.com/mailman/listinfo/oxygen-user

___
oXygen-user mailing list
oXygen-user@oxygenxml.com
https://www.oxygenxml.com/mailman/listinfo/oxygen-user

Re: [oXygen-user] Questions about spell checking

2019-12-10 Thread Oxygen XML Editor Support (Radu Coravu) 

Hi Kris,

Thanks for the feedback, I will add an internal issue to consider adding 
more settings for ignoring various constructs when the spell check is 
performed.
How about if the end users wrap these particular identifiers in some 
specific DITA inline element like  and you instruct the spell 
checker to ignore all code phrases when spell checking?


Regards,
Radu

Radu Coravu
 XML Editor
http://www.oxygenxml.com

On 12/9/2019 6:27 PM, Kristen James Eberlein wrote:
I'm working with a client to get rid of spelling errors in their 
content. After making changes to Spell check configuration and then to 
the DITA source, the errors have moved from over 10,000 to under 400.


I was glad to see that I could configure Spell check to ignore words 
with digits and mixed-case words.


*A question:* Can I configure some additional options, for example, to 
ignore words that contain an underscore? words that contain a period?


--
Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)


___
oXygen-user mailing list
oXygen-user@oxygenxml.com
https://www.oxygenxml.com/mailman/listinfo/oxygen-user


___
oXygen-user mailing list
oXygen-user@oxygenxml.com
https://www.oxygenxml.com/mailman/listinfo/oxygen-user