From owner-freebsd-doc@FreeBSD.ORG Thu Jul 25 18:32:51 2013 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTP id AC8DD80F for ; Thu, 25 Jul 2013 18:32:51 +0000 (UTC) (envelope-from allan.jude@scaleengine.com) Received: from mx1.scaleengine.net (beauharnois2.bhs1.scaleengine.net [142.4.218.15]) by mx1.freebsd.org (Postfix) with ESMTP id 8518A28CB for ; Thu, 25 Jul 2013 18:32:50 +0000 (UTC) Received: from [10.1.1.1] (S01060001abad1dea.hm.shawcable.net [50.70.108.129]) (Authenticated sender: allan.jude@scaleengine.com) by mx1.scaleengine.net (Postfix) with ESMTPSA id 8152835BF4 for ; Thu, 25 Jul 2013 18:23:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=scaleengine.com; s=dkim; t=1374776586; bh=SZmCxWLaz/tFEZpNcPjFos+G/cH5aWas71EIQL1FUCI=; h=Date:From:To:Subject:References:In-Reply-To; b=GEVjJsTBnpEPSUFMm08zX3wJGyqXRbF/raDt3DYeqf0ObN5x0ptqtw5oVstk/mCHu zDyGHVD6POvkspWWHU7c7vON2Llzcb1V32QL5c3AKboDVkP5ttLX5RZ/77SczfE/kj cuPCjpSO9h0lQBlTgZnSP8htRBi8qIn5gRMfZG30= Message-ID: <51F16D10.4070006@scaleengine.com> Date: Thu, 25 Jul 2013 14:23:12 -0400 From: "[ScaleEngine] Allan Jude" Organization: ScaleEngine Inc. User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Thunderbird/20.0 MIME-Version: 1.0 To: freebsd-doc@freebsd.org Subject: Re: and other tag usage References: In-Reply-To: Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 25 Jul 2013 18:32:51 -0000 On 2013-07-25 14:15, Warren Block wrote: > When writing sections, I've generally not used other > markup inside those sections except for . For example: > > rm /tmp/foo > > However, there are some spots in the Handbook where tags > are also used: > > rm /tmp/foo > > 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 > example. > > Anyone care strongly either way? > _______________________________________________ > freebsd-doc@freebsd.org mailing list > http://lists.freebsd.org/mailman/listinfo/freebsd-doc > To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org" I imagine the important bit is if the filename is literal, or replaceable. Is the named file a specific file that might have a man page entry (like rc.conf)? Is it a file whos name the user will likely want to change? It seems a would be useful to point use that extra attention should be paid to the fact that this is a filename, not an argument to a command -- -------------------------------- Allan Jude E: allan.jude@scaleengine.com P: 289-426-5012 M: 289-260-5944