#277 <result> tag

v5.0
open-fixed
5
2014-05-21
2011-01-13
rnewton
No

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.

Discussion

  • rlandmann

    rlandmann - 2011-01-18

    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

    Norman Walsh - 2014-05-21
    • status: open --> open-fixed
    • Group: --> v5.0
     
  • Norman Walsh

    Norman Walsh - 2014-05-21

    We added result in 5.1

     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks