Date: Thu, 25 Jul 2013 21:40:55 +0200 From: Gabor Kovesdan <gabor.kovesdan@gmail.com> To: Warren Block <wblock@wonkity.com>, doc@FreeBSD.org Subject: Re: <userinput> and other tag usage Message-ID: <51F17F47.3060101@FreeBSD.org> In-Reply-To: <alpine.BSF.2.00.1307251203130.12780@wonkity.com> References: <alpine.BSF.2.00.1307251203130.12780@wonkity.com>
next in thread | previous in thread | raw e-mail | index | archive | help
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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?51F17F47.3060101>