#277 <result> tag

[rnewton]

In technical documentation, it would be useful to have a <result> tag that could be used in a <procedure> to indicate what the expected result would be. Here is an example:

<procedure id="turning_on_your_television">
<title>Turning on a Television</title>
<step>
<title>Step One-Locate your remote</title>
<para>Check under the cushions of your couch, in the freezer, or on the floor to find your remote.
</para>
</step>
<step>
<title>Step Two - Press the 'On' button</title>
<para>
Press the 'On' button. It is usually located to the top of your remote.
</para>
<result>Result</result>
<para>
Your television switches on.
</para>
</step>
</procedure>

The following is a real-world example of where we have been using <formalpara> in place of a <result> tag, http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/5/html/Installation_Guide/Installation_With_ZIP_Download.html

Thanks.

[rlandmann]

I like this idea and could certainly use it. However, I think a structure like this makes more sense:

<procedure id="turning_on_your_television">
<title>Turning on a Television</title>
<step>
<title>Step One-Locate your remote</title>
<para>Check under the cushions of your couch, in the freezer, or on the floor to find your remote.</para>
</step>
<step>
<title>Step Two - Press the 'On' button</title>
<para>Press the 'On' button. It is usually located to the top of your remote.</para>
</step>
<result>
<title>Result</title>
<para>Your television switches on.</para>
</result>
</procedure>

Generated text for "Result" could be used when no <title> is supplied.

Cheers
Ruediger

[Norman Walsh]

We added result in 5.1