underscore and italic policy
    Waylan Limberg 
    waylan at gmail.com
       
    Fri Jun 30 15:24:49 EDT 2006
    
    
  
On 6/30/06, Sam Joseph <srjoseph at hawaii.edu> wrote:
[snip]
>
> In our user community at least the much more common use of embedded
> underscores is in database table names and file names, e.g.
>
> my_fave_file.txt
> user_workspaces_tbl
>
[snip]
I don't have anything to add to the italics policy, but when using
file names and table names within a body of text, wouldn't they be
considered inline code[1]? In my experience that is usually how
documentation is formatted. That being the case, one would do:
    `my_fave_file.txt`
    `user_workspaces_tbl`
which, IMHO makes the italics policy irrelevant in this case. True,
you may have users who fail to use the backticks to start with, but
the problem is easy to spot and a simple addition to your FAQ page
should cover those issues.
[1]: http://daringfireball.net/projects/markdown/syntax#code
-- 
----
Waylan Limberg
waylan at gmail.com
    
    
More information about the Markdown-Discuss
mailing list