Date: Thu, 25 Jul 2013 12:15:36 -0600 (MDT) From: Warren Block <wblock@wonkity.com> To: doc@FreeBSD.org Subject: <userinput> and other tag usage Message-ID: <alpine.BSF.2.00.1307251203130.12780@wonkity.com>
next in thread | raw e-mail | index | archive | help
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?
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?alpine.BSF.2.00.1307251203130.12780>