Re: logview doc version 0.1-ish

[Dan Mueth <d-mueth uchicago edu>]

> Since this is my first doc, I wanted to post it before I got too far, to
> make sure I'm doing things right.
> 
> There aren't any figures yet, and there are some weird plus figures that
> I can't figure out, so I would be most grateful for feedback.
> 
> It's at
> 
> ftp://ftp.samsonsource.com/pub/logview/

Judith,

It looks very good.  Here are a few small markup-related things I noticed
which you might want to change:

1) You call it "logview".  I typically call it whatever it calls itself in
the About dialog. In this case it would be "Logview".  (Only difference
here is it is capitalized.) Technically, I think all application names are
supposed to be capitalized, since they are proper names.  However, many
app authors take artistic liberty to break this rule, so I just follow
whatever they do in the About dialog.

2) There are a few places where the <application> markup was ommitted
around the app name, "Logview".

3) You can use the <filename> tag when referring to files, such as
<filename>/var/log/messages</filename>.

4) For directories, you can use <filename
class="directory">/var/log</filename>.  (Anybody have an opinion of
whether we should use "/var/log" for the directory or "/var/log/" ?)

5) You can use <keycap>Page Up</keycap> and similar for marking up "Page
Down".  

6) You have a typo (missing "<") at: <title>Open Log Dialog/title>

It is generally looking very good.

Dan