Search the web
Sign In
New User? Sign Up
dita-users · DITA users group
? Already a member? Sign in to Yahoo!

Yahoo! Groups Tips

Did you know...
Hear how Yahoo! Groups has changed the lives of others. Take me there.

Best of Y! Groups

   Check them out and nominate your group.
Having problems with message search? Fill out this form to ensure your group is one of the first to be migrated to the new message search system.

Messages

  Messages Help
Advanced
Force task topics to new page?   Message List  
Reply | Forward Message #11061 of 16204 |
Reference Topic Titles and QuickProcedure Methodology

Hi All,
 
I wish everyone a particularly happy day today, as it is my engagement anniversary. I asked my wife to be my bride during the annual July 4th Chicago lakefront fireworks, which take place every year...on July 3d. :-)
 
Today, I am considering how to title our reference topics using DITA.
 
For example:

<title>Download Manager Options | [Tab] Mail Setup</title>

That kind of title gives some good info. You're in Download Manager Options, and you're viewing the help for the Mail Setup tab.

However, I've worked out the following use of menucascade:

<menucascade>

<uicontrol>Tools</uicontrol>

<uicontrol>Options...</uicontrol>

<uicontrol>[Tab] Security</uicontrol>

</menucascade>

...and BTW, we'll eventually be pulling the "where is it?" question entirely from the application itself (and inserting into menucascade), so I'm feeling pretty geeky-ego-coolified about that!

Now, my questions are:

How descriptive should the title be?

Here are some options:

1. Mail Setup (all the rest of the info is explained in the topic)

2. Mail Setup Tab (tells more about what it is, but breaks my "QuickProcedure" methodology, which for example works like this:

QuickProcedure

Menu MarketData | [select] Market Data Type | [screen] Search for and find the data item you wish to edit | [action] Overwrite the data item | [action] Complete the task by pressing Tab, Enter, or by continued use of TBD.

and

QuickProcedure

[Windows Taskbar] Click Start | All Programs | [menu] Bulldog Download Manager | [submenu] select Bulldog Download Manager | [screen] click OK.

...and even though I'm still working on the details of the QuickProcedure, I feel like it will be very helpful once I've worked out the kinks. One of the kinks is: do I bracket things like [select]..., or [action] select XYZ, or do I just point out [menu] [submenu] [screen] [tab], etc.?

If I use the methodology [tab] Tabname select the XYZ checkbox, then I'd likely want to do something like

3. [Tab] Mail Setup

for my reference topic titles

or even, what I've come to for now:

4. Download Manager Options | [Tab] Mail Setup

The more I think of it, the more I'm leaning towards naming the reference topic as specifically as possible, which would be Mail Setup, and that's it. Maybe Mail Setup Tab.

Your thoughts and suggestions are most welcome...and hey...wanna help me with my QuickProcedure methodology?

Cheers!

Dainis

-------------------------------
Dainis W. Michel
Documentation
Comfin Software & Consulting Services GmbH
Wollzeile 6-8
1010 Vienna, Austria
Tel: +43 1 513 4704
Fax: +43 1 513 4703
-------------------------------
http://www.music-composition-studio.com
http://www.sustainable-bliss.com
http://www.liquidenglish.com



Thu Jul 3, 2008 4:17 pm

dainis.michel@...
Send Email Send Email

Forward
Message #11061 of 16204 |
Expand Messages Author Sort by Date

Hello, Is it possible to force task topics to a new page within PDF output? Basically, my bookmap has chapters (concepts) and topicrefs (tasks); I want each...
fcabral78
Offline Send Email
Jul 3, 2008
1:15 am

Dear Fred, To perform different customizations of the PDF output you will have to edit the "dita2fo-parms.xsl" file located in the "DITA-OT/xsl/xslfo/"...
Radu Coravu
raducoravu
Offline Send Email
Jul 3, 2008
5:45 am

Hi All, I wish everyone a particularly happy day today, as it is my engagement anniversary. I asked my wife to be my bride during the annual July 4th Chicago...
Dainis Michel
dainis.michel@...
Send Email
Jul 3, 2008
4:17 pm

Dainis, I prefer the title Download Manager Options - Mail Setup Tab. As for the menucascade, Generally I would just state something like: Click...
Julio Vaquez
julio_v27612
Offline Send Email
Jul 4, 2008
3:57 pm
Advanced

Copyright © 2009 Yahoo! Inc. All rights reserved.
Privacy Policy - Terms of Service - Guidelines - Help