<userinput> and other tag usage

Gabor Kovesdan gabor.kovesdan at gmail.com
Thu Jul 25 19:41:15 UTC 2013


On 2013.07.25. 20:15, Warren Block wrote:
> 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? 
I prefer the first approach. The emphasis is on what the user should 
type and not on the fact that it is a filename. Besides, the green 
rendering inside the userinput would be too much.

Gabor


More information about the freebsd-doc mailing list