Userinput

The user input (<userinput>) element represens the text a user should input in response to a program or system prompt. This element is part of the DITA software domain, a special set of DITA elements designed to document software tasks, concepts and reference information.


Contents

[edit] Example

<p>After you type <userinput>mealplan dinner</userinput>, the meal planning program
will print a <systemoutput>For what day?</systemoutput> message.
Reply by typing the day of the week for which you want a meal plan,
for example, <userinput>Thursday</userinput>.</p>

[edit] Contains

Doctype Content model
ditabase, topic, task, reference, concept, glossary (
text data  or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or term or data or data-about or foreign or unknown)  (any number) 

[edit] Contained by

Doctype Parents
ditabase data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, glossterm, glossdef, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
topic data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
task data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
concept data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
reference data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
glossary data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, glossterm, glossdef, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote

[edit] Inheritance:

+ topic/ph sw-d/userinput


[edit] Attributes

Name Description Data Type Default Value Required?
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) A set of related attributes, described at %univ-atts; parameter entity PE not

applicable

Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not

applicable

Not applicable
class, outputclass Common attributes described in Other common DITA attributes      

TOC: Language Specification 1.1
Parent topic: Software elements
Previous topic: filepath
Next topic: systemoutput

Retrieved from "http://www.ditawiki.org/index.php/Userinput"

This page has been accessed 212 times. This page was last modified 12:31, 13 July 2007.





This page
Discuss this page
Post a comment
Printable version
My pages
Log in / create account