<userinput> and other tag usage
Warren Block
wblock at wonkity.com
Thu Jul 25 18:15:44 UTC 2013
When writing <userinput> sections, I've generally not used other markup
inside those sections except for <replaceable>. For example:
<userinput>rm /tmp/foo</userinput>
However, there are some spots in the Handbook where <filename> tags are
also used:
<userinput>rm <filename>/tmp/foo</filename></userinput>
This looks different in the XHTML output, with the filename rendered in
green.
I feel that the first form is correct, we are pointing out what the user
should type, but can see benefits for the second. I have not counted to
see which form is prevalent, but think it is the first. The FDP Primer
actually uses a filename without filename tags in the <userinput>
example.
Anyone care strongly either way?
More information about the freebsd-doc
mailing list