RE: [dita] Another request for steps-informal example

From
Michael Priestley <>
Date
2009-02-02T20:19:40+00:00
ID
Thread
RE: [dita] Another request for steps-informal example
Hi Steve,

You can actually mark that up with steps-ordered,
and leave it to the output process how to format it (for example, the DITA-OT
I think renders a step without siblings as a paragraph). But it's true
that you could use it for single-step procedures, particularly if the step
didn't really conform to the cmd/info etc. model for some reason.

I think another example of steps-informal
might be:

<steps-informal>

    <ol>

        <li>Just
write a simple set of steps</li>

        <li>Because
I can't be bothered with cmd and info subelements</li>

     </ol>

</steps-informal>

Michael Priestley, Senior Technical
Staff Member (STSM)

Lead IBM DITA Architect 



http://dita.xml.org/blog/25

"Fogel, Stephen J"
<> 

02/02/2009 03:11 PM

To

Robert D Anderson <>,
dita <>

cc

Subject

RE: [dita] Another request for steps-informal
example

Robert....

What is the philosophy of the group on how to document a task that has
only one step?

For example, a task topic entitled "Taking a Tablespace Offline"
might look like this:

==============

Taking a Tablespace Offline

Taking a tablespace offline temporarily prevents access to the data stored
in it. You may want to take a tablespace offline when....

To take a tablespace offline, submit the following statemment:

ALTER TABLESPACE tablespace_name OFFLINE;

See also: xxxx

====================

This is really a procedure with one step. Obviously, an ordered list with
one step would look odd, to say the least. How is something like this normally
handled in DITA? Might this be a candidate for this new markup?

Thx

Steve

 

Oracle

Steve Fogel | Information Architect, Oracle Database | 650.506.4914

Oracle Server Technologies Information Development

500 Oracle Parkway | M/S 4op1126 | Redwood Shores, CA 94065

-----Original Message-----

From: Robert D Anderson [mailto:] 

Sent: Monday, February 02, 2009 11:23 AM

To: dita

Subject: [dita] Another request for steps-informal example

Hello everybody,

Early drafts of DITA 1.2 added a <process> element to task for describing
procedural task information that does not fit into <steps>. I asked
a couple of times for an example to include in the language specification,
but didn't get one.

Late last year we changed the name from <process> to <steps-informal>,
but I still don't have an example.

Can anybody on the list provide an example for the <steps-informal>
element? The original proposal does not explain the element beyond what
I've stated above, and does not give an example. I know a number of people
on the TC feel this element is critical, so I would appreciate it if one
of those people can provide an example to include in the Language Specification...

Thanks,

Robert D Anderson

IBM Authoring Tools Development

Chief Architect, DITA Open Toolkit

---------------------------------------------------------------------

To unsubscribe from this mail list, you must leave the OASIS TC that generates
this mail.  Follow this link to all your TCs in OASIS at:

https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php

---------------------------------------------------------------------

To unsubscribe from this mail list, you must leave the OASIS TC that

generates this mail.  Follow this link to all your TCs in OASIS at:

https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php