|
Posted by Simon Brooke on June 25, 2007, 3:45 pm
Please log in for more thread options
('nospam@andrew.invalid') wrote:
> I have created a page that describes the setup for the newsreader
> slrn:
>
> http://people.aapt.net.au/~adjlstrong/slrn.html
>
> I have 2 questions:
>
> 1. Many of the prohrams I describe, such as slrn and ssmtp are
> traditionally written as lower case. Is there a semantically correct
> way to differentiate them from the surrounding text rather than
> wrapping in a span?
There aren't any really strict rules here, and other people will
(reasonably) disagree with me.
In principle CODE is for code samples and VAR is for variable stuff -
typically if documenting a terminal session you'd use VAR for what the
user types and SAMP for what the system responds with.
If you were documenting what the user should type I'd use VAR, but if just
naming the program I would use CODE.
> 2.I have wrapped _filenames_ such as .slrnrc in <code>. Is this a
> legitimate practice or am I stretching the use of <code>?
I'd probably use SAMP or VAR rather than CODE for filenames.
--
simon@jasmine.org.uk (Simon Brooke) http://www.jasmine.org.uk/~simon/
;; So, before proceeding with definitive screwing, choose the
;; position most congenital.
-- instructions for fitting bicycle handlebars
| 
XML Sitemap