Date   

Re: Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

Kristen James Eberlein
 

Folks, let me focus the discussion a little more clearly.

The DITA TC is looking to introduce a domain for hardware controls into DITA 2.0. The question is really how extensive it should be. Would a single element (let's call it <hw-control>) suffice, or do we need more? For example, a discrete control (on/off; 1/2/3/4/5 on a gear shift) or a continuous control (volume control for a radio.)

What we need from you is the following information:

  • What are your current unmet needs for documenting hardware controls?
  • How are you currently documenting hardware controls?
  • (If you specialized) What elements did you create, what are the semantics, and what was the business requirements for the specializations?

In other words, please give us more data than "Yes, I'd find it useful." Why would you find a hardware control domain useful? What are your business requirements?

There is good academic data on hardware controls, which Keith Schengili-Roberts looked at and led to the DITA TC knowledge about discrete and continuous controls. However, we want information and requirements from the user community. That's you :)

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)

 

From: main@dita-users.groups.io <main@dita-users.groups.io> On Behalf Of keith@...
Sent: Wednesday, March 25, 2020 10:51 AM
To: main@dita-users.groups.io
Subject: [dita-users] Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

 

Hello there:

An idea that is being floated for DITA 2.0 is the introduction of a new hardware domain to provide markup for things like the following:
- keyboard combinations like "Ctrl + Alt + Delete"
- a part number element to mark up part numbers
- a way to mark up non-computer controls, covering things like levers, peddles, switches having multiple selections, etc.
In general, the idea is to provide semantic alternatives for the arguably overused uicontrol element in situations that are not necessarily software related (say, for a control lever on a device, an accelerator or gear-shift for a car (which are forms of discrete controls), or a tuner knob on a radio (which is a continuous control)).

I was asked by the DITA TC to ask the members of this forum their thoughts on this idea in general, and whether people would use this markup if it was available.

If this is of interest, please respond! Whether or not we do this is dependant on the responses we get.

Cheers!

~~~~~~~~~~~~~~~~~~~~~~~~
Keith Schengili-Roberts
DITAWriter.com
Chair of OASIS DITA Adoption


Re: Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

 

Absolutely! 
I would use the keyboard and part number items. 
Under UI items, being able to conceptually (and consequently visually) distinguish radio buttons, menus and their items (menu, menu_item), tabs and sub-tabs, and the like would be very useful.  In an XML-defined UI, the definition could be linked between the app and the documentation.

Grant Hogarth 
Technical Writer, Services Tools team
Workiva Inc. 
1700 Platte St, Suite 200, Denver, Colorado 80202 
Mobile: 1-801-815-8353 


On Wed, Mar 25, 2020 at 9:20 AM <keith@...> wrote:
Hello there:

An idea that is being floated for DITA 2.0 is the introduction of a new hardware domain to provide markup for things like the following:
- keyboard combinations like "Ctrl + Alt + Delete"
- a part number element to mark up part numbers
- a way to mark up non-computer controls, covering things like levers, peddles, switches having multiple selections, etc.
In general, the idea is to provide semantic alternatives for the arguably overused uicontrol element in situations that are not necessarily software related (say, for a control lever on a device, an accelerator or gear-shift for a car (which are forms of discrete controls), or a tuner knob on a radio (which is a continuous control)).

I was asked by the DITA TC to ask the members of this forum their thoughts on this idea in general, and whether people would use this markup if it was available.

If this is of interest, please respond! Whether or not we do this is dependant on the responses we get.

Cheers!

~~~~~~~~~~~~~~~~~~~~~~~~
Keith Schengili-Roberts
DITAWriter.com
Chair of OASIS DITA Adoption


Re: Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

Ute Methner
 

Yes, that would be very useful to have.

--



Thank you
Ute


Ute Methner
Sr Analyst Content Development
Technical Publications
Motorola Solutions

o:
+1.819.931.2170






Your privacy is important to us. That is why we have taken appropriate measures to ensure the data you provide to us is kept secure. To learn more about how we process your personal information, how we comply with applicable data protection laws, and care for the security and privacy of your personal data, please review our Privacy Policy. If you have any questions related to data protection and compliance with applicable laws, please contact us at our Security Operations Center at 1-800-674-4357.


Re: Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

Reece Roggentien
 

I’d also use keyboard combinations. Similarly, there are hardware components or interactions that aren’t part of a keyboard but perform similar functions. On Windows, for example, I might use “Ctrl+P” to take a screenshot while on my iPhone I’d press “Power + volume”. Gestures are also common and I could see myself using a <gesture> tag or something like it.

 

-Reece

 

:main@dita-users.groups.io] On Behalf Of Allan Jenoff via Groups.Io
Sent: Wednesday, March 25, 2020 10:25 AM
To: main@dita-users.groups.io
Subject: Re: [dita-users] Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

 

I would definitely b using keyboard combinations. It is long overdue.

 

From: main@dita-users.groups.io <main@dita-users.groups.io> On Behalf Of keith@...
Sent: Wednesday, March 25, 2020 10:51 AM
To: main@dita-users.groups.io
Subject: [dita-users] Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

 

Hello there:

An idea that is being floated for DITA 2.0 is the introduction of a new hardware domain to provide markup for things like the following:
- keyboard combinations like "Ctrl + Alt + Delete"
- a part number element to mark up part numbers
- a way to mark up non-computer controls, covering things like levers, peddles, switches having multiple selections, etc.
In general, the idea is to provide semantic alternatives for the arguably overused uicontrol element in situations that are not necessarily software related (say, for a control lever on a device, an accelerator or gear-shift for a car (which are forms of discrete controls), or a tuner knob on a radio (which is a continuous control)).

I was asked by the DITA TC to ask the members of this forum their thoughts on this idea in general, and whether people would use this markup if it was available.

If this is of interest, please respond! Whether or not we do this is dependant on the responses we get.

Cheers!

~~~~~~~~~~~~~~~~~~~~~~~~
Keith Schengili-Roberts
DITAWriter.com
Chair of OASIS DITA Adoption


Re: Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

Thomas Rathkamp
 

I "third" that motion ;)



Tom Rathkamp
Senior Technical Writer




On Wednesday, March 25, 2020, 10:38:35 AM CDT, CharJTF <charjtf@...> wrote:


I'd definitely be in favor of more semantic alternatives.

Char

On Wed, Mar 25, 2020 at 11:25 AM Allan Jenoff <allan.jenoff@...> wrote:

I would definitely b using keyboard combinations. It is long overdue.

 

From: main@dita-users.groups.io <main@dita-users.groups.io> On Behalf Of keith@...
Sent: Wednesday, March 25, 2020 10:51 AM
To: main@dita-users.groups.io
Subject: [dita-users] Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

 

Hello there:

An idea that is being floated for DITA 2.0 is the introduction of a new hardware domain to provide markup for things like the following:
- keyboard combinations like "Ctrl + Alt + Delete"
- a part number element to mark up part numbers
- a way to mark up non-computer controls, covering things like levers, peddles, switches having multiple selections, etc.
In general, the idea is to provide semantic alternatives for the arguably overused uicontrol element in situations that are not necessarily software related (say, for a control lever on a device, an accelerator or gear-shift for a car (which are forms of discrete controls), or a tuner knob on a radio (which is a continuous control)).

I was asked by the DITA TC to ask the members of this forum their thoughts on this idea in general, and whether people would use this markup if it was available.

If this is of interest, please respond! Whether or not we do this is dependant on the responses we get.

Cheers!

~~~~~~~~~~~~~~~~~~~~~~~~
Keith Schengili-Roberts
DITAWriter.com
Chair of OASIS DITA Adoption


Re: Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

CharJTF
 

I'd definitely be in favor of more semantic alternatives.

Char


On Wed, Mar 25, 2020 at 11:25 AM Allan Jenoff <allan.jenoff@...> wrote:

I would definitely b using keyboard combinations. It is long overdue.

 

From: main@dita-users.groups.io <main@dita-users.groups.io> On Behalf Of keith@...
Sent: Wednesday, March 25, 2020 10:51 AM
To: main@dita-users.groups.io
Subject: [dita-users] Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

 

Hello there:

An idea that is being floated for DITA 2.0 is the introduction of a new hardware domain to provide markup for things like the following:
- keyboard combinations like "Ctrl + Alt + Delete"
- a part number element to mark up part numbers
- a way to mark up non-computer controls, covering things like levers, peddles, switches having multiple selections, etc.
In general, the idea is to provide semantic alternatives for the arguably overused uicontrol element in situations that are not necessarily software related (say, for a control lever on a device, an accelerator or gear-shift for a car (which are forms of discrete controls), or a tuner knob on a radio (which is a continuous control)).

I was asked by the DITA TC to ask the members of this forum their thoughts on this idea in general, and whether people would use this markup if it was available.

If this is of interest, please respond! Whether or not we do this is dependant on the responses we get.

Cheers!

~~~~~~~~~~~~~~~~~~~~~~~~
Keith Schengili-Roberts
DITAWriter.com
Chair of OASIS DITA Adoption


Re: Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

Allan Jenoff
 

I would definitely b using keyboard combinations. It is long overdue.

 

From: main@dita-users.groups.io <main@dita-users.groups.io> On Behalf Of keith@...
Sent: Wednesday, March 25, 2020 10:51 AM
To: main@dita-users.groups.io
Subject: [dita-users] Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

 

Hello there:

An idea that is being floated for DITA 2.0 is the introduction of a new hardware domain to provide markup for things like the following:
- keyboard combinations like "Ctrl + Alt + Delete"
- a part number element to mark up part numbers
- a way to mark up non-computer controls, covering things like levers, peddles, switches having multiple selections, etc.
In general, the idea is to provide semantic alternatives for the arguably overused uicontrol element in situations that are not necessarily software related (say, for a control lever on a device, an accelerator or gear-shift for a car (which are forms of discrete controls), or a tuner knob on a radio (which is a continuous control)).

I was asked by the DITA TC to ask the members of this forum their thoughts on this idea in general, and whether people would use this markup if it was available.

If this is of interest, please respond! Whether or not we do this is dependant on the responses we get.

Cheers!

~~~~~~~~~~~~~~~~~~~~~~~~
Keith Schengili-Roberts
DITAWriter.com
Chair of OASIS DITA Adoption


Any Interest in a Hardware Domain for Non-computer Buttons/Controls? #DITAv2-0

keith@...
 

Hello there:

An idea that is being floated for DITA 2.0 is the introduction of a new hardware domain to provide markup for things like the following:
- keyboard combinations like "Ctrl + Alt + Delete"
- a part number element to mark up part numbers
- a way to mark up non-computer controls, covering things like levers, peddles, switches having multiple selections, etc.
In general, the idea is to provide semantic alternatives for the arguably overused uicontrol element in situations that are not necessarily software related (say, for a control lever on a device, an accelerator or gear-shift for a car (which are forms of discrete controls), or a tuner knob on a radio (which is a continuous control)).

I was asked by the DITA TC to ask the members of this forum their thoughts on this idea in general, and whether people would use this markup if it was available.

If this is of interest, please respond! Whether or not we do this is dependant on the responses we get.

Cheers!

~~~~~~~~~~~~~~~~~~~~~~~~
Keith Schengili-Roberts
DITAWriter.com
Chair of OASIS DITA Adoption


Re: WebHelp test server for DITA project #HTML5 #Oxygen

Matt Lorenzi
 

Thanks to both of you, this should give me enough for IT to do something with. Yes we do use Sharepoint and One Drive so that may be a solution.


Re: WebHelp test server for DITA project #HTML5 #Oxygen

Thomas Rathkamp
 

Hi Matt,

IT set it up for me but I do not think it was that involved.  It is connected to One Drive so I can upload updates via Windows Explorer. If your company does not use Sharepoint, then I would definitely look into Radu's suggestions in his reply to you. 

Tom Rathkamp
Senior Technical Writer




On Tuesday, March 24, 2020, 10:16:59 PM CDT, Matt Lorenzi via Groups.Io <mjlorenzi@...> wrote:


I'm not sure, how easy is it to publish a website to Sharepoint?


Re: Using roboto font #PDF #DITA-OT

ronny.flink@...
 

Thank you all for your replies,

The problem is solved, thanks this email reply below: 😎

“Are you on Windows? If so, make sure you have installed the font for all users. Right-click the font name in Window Explorer and choose Install for all users. Oxygen seems to run under the administrator user.
 
We just struggled with this same issue when getting a new writer up and running on Windows (I’m on Mac)”

I’m on Windows, so what I did was download the font again and right click “Install for all users”

Best regards
Ronny


Re: Using roboto font #PDF #DITA-OT

Kristen James Eberlein
 

I have used Roboto as the font for PDF plug-ins without any problems.

Have you:

  • Verified that the Roboto fonts are installed on the system where DITA-OT installed?
  • Examined the DITA-OT log to see if there are errors about fonts not being found?
  • Correctly specified Roboto in the font mappings file?
  • Correctly specified the font mappings file in the catalog file?

Thank you for making me aware of the Oxygen resource about PDF customization; I was not aware of it.

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 3/24/2020 2:13 PM, ronny.flink@... wrote:
Dear DITA users,
Please, I hope anyone here can help me, because this is making me go insane.
I’m trying to publish a PDF with the Roboto using DITA-OT 3.3.1 and FOP.
I have tried to follow this step by step: https://github.com/oxygenxml/com.oxygenxml.pdf2.ug/wiki/Custom-fonts
But without any success, feels like I have made every minor tweak a hundred times. The font-mapping works and I can get fonts like Tahoma or Trebucet in the PDF output.
Also tried all kinds of changes to the fop.xconf.
If anyone of you have made Roboto font work with FOP, please share.

Best regards
Ronny


Re: WebHelp test server for DITA project #HTML5 #Oxygen

Radu Coravu
 

Hi Matt,

One solution is to have an internal server with an Apache HTTP Server or ‪Firefly‬ installed on it to serve your static HTML pages.

Another solution is to use a hosted solution like Netlify. You create an account in Netlify using your gmail address for example and if you have on the local disk the folder containing the WebHelp HTML output you can drag and drop it in the web page:

https://app.netlify.com/drop

Netlify can also be used to automate the publishing of DITA content to outputs like WebHelp or PDF and it can connect to a GitHub repository with DITA content, detect changes in it and launch a publishing script to automatically update the published outputs, like I did for the Oxygen XML Blog:

https://oxygenxmlblog.netlify.com/topics/welcome.html

Regards,

Radu

Radu Coravu
Oxygen XML Editor
On 3/24/20 10:24 PM, Matt Lorenzi via Groups.Io wrote:

I am looking for some technical information for a Webhelp test environment. I am looking to showcase Webhelp produced with OxygenXML Author to internal stakeholders.
What kind of server setup would be best for a testing environment; also would I need a publishing client to publish to the host?

I realize this is not really DITA specific, but since I am writing in a DITA environment using OxygenXML, this would be a good place to ask. Also I need to give my IT people some technical sounding information to help move this along.


  


Re: Using roboto font #PDF #DITA-OT

Ron Wheeler
 

What operating system are you using to produce the PDF?
Are you sure that Roboto is installed on your computer?
Ron

On 2020-03-24 2:13 p.m., ronny.flink@... wrote:
Dear DITA users,
Please, I hope anyone here can help me, because this is making me go insane.
I’m trying to publish a PDF with the Roboto using DITA-OT 3.3.1 and FOP.
I have tried to follow this step by step: https://github.com/oxygenxml/com.oxygenxml.pdf2.ug/wiki/Custom-fonts
But without any success, feels like I have made every minor tweak a hundred times. The font-mapping works and I can get fonts like Tahoma or Trebucet in the PDF output.
Also tried all kinds of changes to the fop.xconf.
If anyone of you have made Roboto font work with FOP, please share.

Best regards
Ronny


Re: WebHelp test server for DITA project #HTML5 #Oxygen

Matt Lorenzi
 

I'm not sure, how easy is it to publish a website to Sharepoint?


Re: pass parameter using command line #DITA-OT

scott ashmead
 

Thank You!

On Tuesday, March 24, 2020, 09:23:24 PM EDT, Mark Giffin <mark@...> wrote:


Hi Scott,

I assume you are using a late-model DITA OT. Usually you can use the Java-style -Dnn syntax for extra command line parameters, like this example for the clean.temp parameter:

dita -f html5 -i path/to/mymap.ditamap -Dclean.temp=no

This sets clean.temp to no. This style is described here:

https://www.dita-ot.org/3.4/topics/build-using-dita-command.html

If your parameter is custom to your code, the parameter needs to be made available on the command line, and to do that there is an extra step, covered here:

https://www.dita-ot.org/3.4/topics/plugin-xsltparams.html

This works in a similar manner in 2.x versions of the OT. And even earlier!

Mark Giffin
Mark Giffin Consulting, Inc.
http://markgiffin.com/


On 3/24/2020 3:37 PM, scott ashmead via Groups.Io wrote:
Hi DITA users

Does anyone know of a way to pass in a parameter value from the DITA-OT command line?

Currently the param is hard-coded in the XSLT, but I'd like to have the flexibility to modify it.

This is how the param is defined in the XSLT...<xsl:param name="xyz" as="xs:string" select="'file:///c:/temp/xyz.xml'"/>

Regards,
Scott


Re: pass parameter using command line #DITA-OT

Mark Giffin
 

Hi Scott,

I assume you are using a late-model DITA OT. Usually you can use the Java-style -Dnn syntax for extra command line parameters, like this example for the clean.temp parameter:

dita -f html5 -i path/to/mymap.ditamap -Dclean.temp=no

This sets clean.temp to no. This style is described here:

https://www.dita-ot.org/3.4/topics/build-using-dita-command.html

If your parameter is custom to your code, the parameter needs to be made available on the command line, and to do that there is an extra step, covered here:

https://www.dita-ot.org/3.4/topics/plugin-xsltparams.html

This works in a similar manner in 2.x versions of the OT. And even earlier!

Mark Giffin
Mark Giffin Consulting, Inc.
http://markgiffin.com/


On 3/24/2020 3:37 PM, scott ashmead via Groups.Io wrote:
Hi DITA users

Does anyone know of a way to pass in a parameter value from the DITA-OT command line?

Currently the param is hard-coded in the XSLT, but I'd like to have the flexibility to modify it.

This is how the param is defined in the XSLT...<xsl:param name="xyz" as="xs:string" select="'file:///c:/temp/xyz.xml'"/>

Regards,
Scott


pass parameter using command line #DITA-OT

scott ashmead
 

Hi DITA users

Does anyone know of a way to pass in a parameter value from the DITA-OT command line?

Currently the param is hard-coded in the XSLT, but I'd like to have the flexibility to modify it.

This is how the param is defined in the XSLT...<xsl:param name="xyz" as="xs:string" select="'file:///c:/temp/xyz.xml'"/>

Regards,
Scott


Re: WebHelp test server for DITA project #HTML5 #Oxygen

Thomas Rathkamp
 

We use Sharepoint, mainly because it was already in use for other purposes where I work.  



Tom Rathkamp
Senior Technical Writer




On Tuesday, March 24, 2020, 03:24:24 PM CDT, Matt Lorenzi via Groups.Io <mjlorenzi@...> wrote:


I am looking for some technical information for a Webhelp test environment. I am looking to showcase Webhelp produced with OxygenXML Author to internal stakeholders.
What kind of server setup would be best for a testing environment; also would I need a publishing client to publish to the host?

I realize this is not really DITA specific, but since I am writing in a DITA environment using OxygenXML, this would be a good place to ask. Also I need to give my IT people some technical sounding information to help move this along.


WebHelp test server for DITA project #HTML5 #Oxygen

Matt Lorenzi
 

I am looking for some technical information for a Webhelp test environment. I am looking to showcase Webhelp produced with OxygenXML Author to internal stakeholders.
What kind of server setup would be best for a testing environment; also would I need a publishing client to publish to the host?

I realize this is not really DITA specific, but since I am writing in a DITA environment using OxygenXML, this would be a good place to ask. Also I need to give my IT people some technical sounding information to help move this along.