Date   

Re: #Oxygen #Oxygen

ritus@...
 

Hi Radu,

 

Thank you! for your response.

In Oxygen, I see only concept, reference, task, and topic as options for xref >type attribute by default.

Can this be customized?

 

Thanks,
Ritu


Re: [Ann] Oxygen Terminology Checker add-on version 2.0.

Adam Myers
 

Ugh - Thank you! Everything is working now!

Adam


Re: #Oxygen #Oxygen

Radu Coravu
 

Hi Ritu,

You seem to have attached an image but I'm having trouble opening it, can you change its format from emf to some more common format like PNG?

You can use the Oxygen Attributes view to set the @type attribute on an xref element.

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 11/16/20 1:50 PM, ritus@... wrote:

Hi All,
I wanted to understand, does Oxygen support use-by-reference Footnote?  
I don’t see the support for type =”fn” for xref element in Oxygen  22.1  
 
Thanks, Ritu

  


Re: [Ann] Oxygen Terminology Checker add-on version 2.0.

Radu Coravu
 

Hi Adam,

I'm happy you are enjoying the add-on.

It looks like as if you downloaded from Github the HTML equivalents of the Yaml files, not the Yaml files themselves.

Can you open each Yaml file and make sure it's contents is Yaml and not HTML?

For example if I open a Yaml file in Github:

https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Accessibility.yml

there is a "Raw" button there. You should press that button to get the actual contents of the file.

Maybe you can download the entire Vale Microsoft style guide GitHub project as a zip:

https://github.com/errata-ai/Microsoft/archive/master.zip

and obtain the Yaml files from that zip instead of manually downloading them.

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 11/12/20 6:51 PM, Adam Myers wrote:

Hi Radu,

I love this. I have been testing it out this morning and can't wait to share it with my team. I downloaded some of the Microsoft .yml files and the are correctly identifying issues that I created in my test topic. The one issue I am having is I am getting validation errors on the .yml files.

mapping values are not allowed here
 in 'reader', line 147, column 34:
        <span style="background-color: #79b8ff;width: 0%;" class="Pro ... 
                                     ^
The terminology issues are underlined in the editor. What should I do about these validation errors?
 
Thanks,
 
Adam

  


Re: [Ann] Oxygen Terminology Checker add-on version 2.0.

Adam Myers
 

Hi Radu,

I love this. I have been testing it out this morning and can't wait to share it with my team. I downloaded some of the Microsoft .yml files and the are correctly identifying issues that I created in my test topic. The one issue I am having is I am getting validation errors on the .yml files.

mapping values are not allowed here
 in 'reader', line 147, column 34:
        <span style="background-color: #79b8ff;width: 0%;" class="Pro ... 
                                     ^
The terminology issues are underlined in the editor. What should I do about these validation errors?
 
Thanks,
 
Adam


#Oxygen #Oxygen

ritus@...
 

Hi All,
I wanted to understand, does Oxygen support use-by-reference Footnote?  
I don’t see the support for type =”fn” for xref element in Oxygen  22.1  
 
Thanks, Ritu


[Ann] Oxygen Terminology Checker add-on version 2.0.

Radu Coravu
 

Hi everyone,

We are glad to announce version 2.0 of our Terminology Checker add-on is now available in the Oxygen XML default add-on repository.

The add-on is free and is compatible with any Oxygen XML Editor or XML Author version 20.0 and newer.

To install the add-on, follow these instructions:

  1. Go to Help > Install new add-ons... to open an add-on selection dialog box.
  2. Select "Default Update Site" (or paste https://www.oxygenxml.com/InstData/Addons/default/updateSite.xml) in the Show add-ons from field.
  3. Select the Terminology Checker add-on and click Next.
  4. Select the I accept all terms of the end user license agreement option and click Finish.
  5. Restart the application.

Version 2.0 of the add-on brings these useful new features:

  • Partial support to load Vale rules and use them to highlight problems.

    Supported Vale scopes: heading, table.header, table.cell, list, paragraph, code,strong, emphasis.

    Supported Vale extension points: Existence, Substitution, Occurrence.

    For example, you can download the Microsoft style guide yaml rules and add them to the terminology folder configured in the Preferences->Plugins / Terminology Checker page.

  • The new Terminology Helper side view gives an overview of the terminology problems. Clicking in the side view on the incorrect term will focus the matching term in editor area.
  • Share favorite rules with the team: define a folder oxygen-term-checker in the root of your project and terms are automatically loaded from it.
  • Use capturing groups in the suggestions and messages in your custom term rules using the term match regular expression.
  • Match user defined custom terms at word level, character level or with a regular expression.
  • Insert replacement suggestion value as plain-text or as XML fragment.
  • Set problem severity (info, warning or error) for each matched term.
  • Enable/disable add-on from the tool bar without restarting Oxygen.

The screenshot below shows how the Terminology Helper side view displays various problems detected using the Vale Microsoft Style guide rules.

We hope you will find the plugin useful and as always any feedback is welcomed.

Best regards,

Radu

Radu Coravu

Oxygen XML Editor


Oxygen Content Fusion experiences

Michael McLoughlin
 

We're looking at Oxygen Content Fusion as a possible review tool. I'm looking for some experiences of folks who are using or have used it in the past.

Particularly, ease of installation and maintenance. Any info speed and general performance would also be gratefully received.

(Syncrosoft sales folks - we'll be in touch -  but we are just looking for user experiences for the moment).

Thanks!
--
Michael McLoughlin
Senior Technical Writer
Puppet


[ann][webinar] How practitioners can get published and ignite change with Pam Estes Brewer #Room42 Nov 11th @ 15:30 UTC #room42

Liz Fraley
 

Title: How practitioners can get published and ignite change

When: Wednesday, Nov 11th @ 15:30 UTC
(8:30 LAX | 11:30 NYC | 16:30 LON | 20:00 BLR)


Register: http://bit.ly/room42-brewer

Description:

Pam Estes Brewer will be In The Room!

Room 42 is where practitioners and academics meet to share knowledge about breaking research in an approachable, accessible way.

In our next session, Pam Estes Brewer, Mercer University, will be in the room.

Her research focuses on topics related to communication in virtual teams, online teaching, usability, and research methods. She teaches general technical communication courses as well as advanced and graduate courses in usability research, research methods, and international tech comm. She’ll be discussing how industry practitioners, who are working out on the front lines, can conduct reliable and valid research that can be published and instigate change in the workplace.

We're looking forward to exploring how industry experience can lead to publishable research in the next Room 42.


Pam Estes Brewer, Ph.D., Professor at Mercer University, is a technical communicator, educator, and management consultant. She teaches in Mercer University’s School of Engineering and directs the online MS in Technical Communication Management, the Mercer User Experience Lab and its work with such organizations as the Department of Homeland Security. She serves as an Associate Editor for IEEE Transactions on Professional Communication and as a board member for the Wesley Foundation of Macon.


-:-

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


Register: http://bit.ly/room42-brewer


Re: Variable text referenced using keys

Patricia Billard
 

Hi Kristen,

Thank you for the suggestion. I'll bring it up to the team.  We had not considered <text>, I think partly because the DITA 1.2 spec did not address variable elements in an obvious way if you weren't using keys.  The spec's suggestion also steered us away from looking at <text> for variables when we did our original migration:  "For contexts where ph is available, authors should use that element. Where keyword is available, authors should use that element. Where neither ph nor keyword is available, text can be used to pull content by conref." We also implemented some nested variables, in which the company name was referenced in the variable defined for the product name, for example.
The original discussion was a long time ago, but at the time <ph> seemed the best choice for most things, and we had a few other elements we allowed as variables, but I don't think we anticipated needing to use the company name in some of these situations. It might be a solution to use <text> for variables that we don't want to create multiple variable names for the same thing.
--Trish   


[ANN] Major new version of DITA-OT PDF plugin: looking for Beta testers

Corinna Kinchin
 

Dear DITA users,

 

Do you currently produce PDFs with DITA content? Would you be interested in testing a fully GUI PDF design and output tool? If so, please join our Beta testing program for the next major release of the MiramoPDF DITA-OT plugin, version 2.0. No matter whether you are an XSL-FO/XSLT expert, a graphic designer, or a content creator, we welcome your contribution! Active beta testers receive a FREE copy of MiramoPDF as well as a photo of some beautiful Irish cows as a thank-you for your efforts.


While testing, you’ll have a chance to explore powerful, easy-to-use features like:

 

  • GUI page layouts and image placement
  • GUI paragraph and character format assignment
  • Tagged PDF (PDF UA / accessibility)
  • Java job processing API
  • Packaged templates
  • HTTP access to images and packaged templates
  • OpenType font features
  • Videos in PDF output
  • Backend access to XSLT if needed for specialized processing

 

And more!

 

If you're interested, please email betaTest@.... Include your questions and some or all of the following information to help us provide you with the appropriate software:

 

Your name:

Company name:    [optional]

Test platform:   Windows, MacOS and/or Linux

DITA-OT version:

Some background info (such as current tool chain, experience with XSLT and XSL:FO, if any)

 

I'll look forward to welcoming you to the MiramoPDF version 2 beta program!


Corinna Kinchin,
Development Manager, Datazone Ltd, Kenmare, Kerry, Ireland
Tel: +353 64 66 289 64. ckinchin@...

 

 

MiramoPDF: "All the power, a tenth the time"

 

About us

MiramoPDF is a low-cost commercial solution that enables DITA users to produce PDF output without writing a line of XSL:FO or XSLT code.

Page layouts and all other formats, table layouts, paragraphs, etc, are controlled via a GUI.

 

Supported DITA-OT versions

        - 2.4 and above

 

Platforms

        - Windows  (Windows 10, Windows Server 2008 and above)

        - Linux *NEW* (Amazon AWS, CentOS 7, Oracle Linux 7.6)

        - MacOS *NEW* (Catalina)

 


Re: Key definitions for variable text: Conditional processing

despopoulos_chriss
 

We have two levels of conditional processing.  Either we want different variable values, or we want different overall statements.  For example, we might say <p audience= "Bar">The <ph keyref="FOO"/> is a whizbang.</p> 

If we want FOO to express different things, we use a different keydef map.  For example, we OEM to different companies, and we need FOO to give the correct product name.  To do that we use a different set of keydefs.  Note that we transform in the browser, and actually show our content in the GUI.  We include the keydef map in a set of branding files that we pick up at build time, so all the variables come out right.

Now let's say that Bar is for a product level, or a customer role.  We use ditaval files for PDF generation, and that comes out fine.  We also implement filtering in our browser-based transforms, so we can hide the content as needed.  For some types of audience filtering, we can preset that in the build.  Other types depend on the current state of the user/product relationship...  We get the state and then inject the filtering in our system at run time.


Key definitions for variable text: Conditional processing

Kristen James Eberlein
 

Hi, dita-users community.

I have another question about variable text defined by keys. (Variable text is is text that you want to appear differently based on the context.)

For implementations that use keys to define variable text:

  1. How do you handle conditional processing of the key definitions?
  2. What markup are you currently using for this?

Again, for DITA 2.0, the DITA TC is introducing simplified markup and processing for variable content referenced using keys. I am soliciting background information that will help us ensure that we are covering relevant use cases in the best way.

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



[ann][webinar] Introducing the Oxygen Publishing Engine for DITA #Oxygen

alin_belu@...
 

Hello, 
 
Next Wednesday, on November 4, you are invited to our latest live event - “Introducing the Oxygen Publishing Engine for DITA” webinar! 
 
Have you been looking for a solution that offers support for transforming your DITA content into PDF and WebHelp output? Look no further! 
 
In this webinar, Julien Lacour, software developer at Syncro Soft, will introduce you to the Oxygen Publishing Engine – an automation product that bundles the DITA Open toolkit transformation engine with Oxygen publishing plugins and the PDF Chemistry engine. 
 
This event will represent a crash-course for you to learn what the Oxygen Publishing Engine is by showing you how to install it, configure it in a Continuous Integration system, and then customize your output. 
 
You will be shown its components, various workflows, and also get the chance to see how to transform a DITA map document by learning how to: 
* Use the “DITA Map PDF – based on HTML5 & CSS” transformation on an integration server using a publishing template for customizing the output. 
* Create a custom CSS stylesheet and use it in your transformation to get that extra level of customization for your specific needs. 
* Debug the CSS inside both a web browser and Oxygen to see how to choose the correct selectors and properties used for further styling your content. 
 
This is a free event and you can register at http://www.oxygenxml.com/evs2020-15.html 
 
Make sure to check the full list of our upcoming Events: https://www.oxygenxml.com/events_programme.html 
 
Best regards,
Alin
--
Alin Belu
Oxygen XML Editor


[ann][webinar] Navigating Tech Comm with Geoffrey Chaucer with Brigid Brockway #tcdojo free 2 Nov @ 9AM PT

Liz Fraley
 

Title: Navigating Tech Comm with Geoffrey Chaucer

When: Monday, 2 Nov, 9:00 AM - 9:30 AM PT

Register: http://bit.ly/tcdojo-202011-brockway

Description:

Most people know Geoffrey Chaucer as the author of The Canterbury Tales, a group of stories so naughty that schoolbooks still censor them now, over 600 years later. Many are surprised to learn that Geoffrey Chaucer also wrote one of the oldest surviving technical documents written in the English language.

More surprising still is the fact that this document, A Treatise on the Astrolabe, remains an example of excellent technical writing even by today’s standards. An astrolabe is an ancient instrument that helped astronomers study the stars, surveyors study the land, and sailors study the sea. In this session we’ll use Chaucer and his astrolabe to study the timeless elements of great technical communication.

Attendees will view advanced writing and editing skills through an ancient lens and emerge ready to produce concrete, concise, and cutting-edge documentation that’s just right for their audience.

About the Visiting TC Dojo Master:

Brigid Brockway worked as a technical writer for DRB Systems, an industry leader in car care solutions, for nearly fifteen years. She has a BA in English from Ursuline College and a Masters of Fine Arts in Creative Writing: Nonfiction from Ashland University. Her work has been featured on National Public Radio and in “Every Pigeon” literary magazine.


-:-

The TC Dojo is brought to you by Single-Sourcing Solutions. At the TC Dojo, you pick the topics and we find the experts. Learn more: http://webinar.tcdojo.org


Register: http://bit.ly/tcdojo-202011-brockway


Re: Variable text referenced using keys

Kristen James Eberlein
 

Hi, Shane.

You might want to specialize to create the particular key-definition elements that you want for your writers. Or could you institute guardrails by implementing constraints or hiddening certain elements from authors? Establish best patterns for key definitions through authoring templates?

I'd be curious to see the types of anti-patterns ("malarkey") that you have seen authors try. Willing to share some?

There are limitations to the numbers and kinds of elements that we introduce into the actual body of DITA. We need to be cognizant of the element count and make sure that what we introduce has a really wide utility for the community of DITA users.

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 10/28/2020 5:30 PM, Shane Taylor wrote:
Definitely not asking to disallow @href for all keys, just text-only ones.

The use case for eliminating the intervening <topicmeta> is nothing more than simplifying the markup. It's never seemed a useful tag, and less so when defining text-only keys when no other content should be provided but the text for the key.

As it stands today, the flexibility of key definition markup allows authors to do a lot of things that make no sense semantically and won't work. Onboarding new writers would be aided by markup that enforced valid use cases and disallowed malarkey ;-).

Shane Taylor


On Wed, Oct 28, 2020 at 12:36 PM Kristen James Eberlein <kris@...> wrote:

Hi, Shane. A couple of points:

  • Disallowing an @href is not an option. A lost of implementations use keys to reference images, and in such scenarios, the alternate text for the image is provided by the variable text. For example, using current DITA 1.3 markup:

        <keydef keys="company-logo" href="images/eberlein-consulting-logo.png">
          <topicmeta>
            <keywords>
              <keyword>Logo for Eberlein Consulting LLCS</keyword>
            </keywords>
          </topicmeta>
        </keydef>


  • What is your use case for "including <keytext>—if necessary, in a new parent like <keytextdef>— without the intervening <topicmeta>"?
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 10/28/2020 12:08 PM, Shane Taylor wrote:
  • To simplify the markup, I like the <keytext> approach to standardize this, since there are now multiple elements/attributes you can use that each have different priorities and implementation. Additionally, could we:
  • disallow specifying an @href
  • include <keytext>—if necessary, in a new parent like <keytextdef>— without the intervening <topicmeta>


Re: Glossary term: singular vs. plural #glossary

Wito Zoerkler
 

Hi, Joe,

thanks for your feedback.
I also don't mind if the glossary term in the glossary is in the singular and is used in the plural in the text.
My question was more about what is the best technical solution for this.
Example:
  • 'software module' is defined in a glossary topic (singular). The output can be different depending on the format (e.g. glossary chapter in PDF, mouse hover)
  • By default, glossary words are inserted into the text as follows: <abbreviated-form keyref="KEYNAME"/> or <term keyref="KEYNAME">, i.e. they would then appear as a singular in the text.
The question is, how can I use the glossary term in the text in the plural?
<term keyref="KEYNAME">software modules</term> is just an idea. The question is whether it is a good idea? Does anyone have any experience with this? It won't work with <abbreviated-form> because the content model doesn't allow any element or text (which makes sense because either the <glossSurfaceForm> or <glossAcronym> is rendered in the output).

Any idea how to deal with it best?

Best
Wito


Re: Con(key)reffing terms: uppercase - lowercase

Joe Russo
 

Thanks Jang! Silly mistake on my part. As an avid cyclist, who hasn't been to either, I hope to make it to both some day!


Re: Glossary term: singular vs. plural #glossary

Joe Russo
 

So are you thinking of something like:
<p>Instead of writing monolithic code, you can use <term keyref="KEYNAME">software modules</term> to make your programs more agile.</p>

And then a pop-up that would say something like:
A software module is a block of code that can be reused.

This mix of singular and plural doesn't bother me at all.


Re: Variable text referenced using keys

Shane Taylor
 

Definitely not asking to disallow @href for all keys, just text-only ones.

The use case for eliminating the intervening <topicmeta> is nothing more than simplifying the markup. It's never seemed a useful tag, and less so when defining text-only keys when no other content should be provided but the text for the key.

As it stands today, the flexibility of key definition markup allows authors to do a lot of things that make no sense semantically and won't work. Onboarding new writers would be aided by markup that enforced valid use cases and disallowed malarkey ;-).

Shane Taylor


On Wed, Oct 28, 2020 at 12:36 PM Kristen James Eberlein <kris@...> wrote:

Hi, Shane. A couple of points:

  • Disallowing an @href is not an option. A lost of implementations use keys to reference images, and in such scenarios, the alternate text for the image is provided by the variable text. For example, using current DITA 1.3 markup:

        <keydef keys="company-logo" href="images/eberlein-consulting-logo.png">
          <topicmeta>
            <keywords>
              <keyword>Logo for Eberlein Consulting LLCS</keyword>
            </keywords>
          </topicmeta>
        </keydef>


  • What is your use case for "including <keytext>—if necessary, in a new parent like <keytextdef>— without the intervening <topicmeta>"?
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 10/28/2020 12:08 PM, Shane Taylor wrote:
  • To simplify the markup, I like the <keytext> approach to standardize this, since there are now multiple elements/attributes you can use that each have different priorities and implementation. Additionally, could we:
  • disallow specifying an @href
  • include <keytext>—if necessary, in a new parent like <keytextdef>— without the intervening <topicmeta>

441 - 460 of 46295