Re: [PATCH] user-manual: mention git gui citool (commit, amend)

From: Shawn O. Pearce <spearce@spearce.org>
Date: Aug 6, 2007, 04:06 UTC
Message-ID: <20070806040626.GI9527@spearce.org>
In-Reply-To: <608102.66070.qm@web38905.mail.mud.yahoo.com>

Brett Schwarz <brett_schwarz@yahoo.com> wrote:

Show 13 quoted lines

> > From: Shawn O. Pearce <spearce@spearce.org>
> > 
> > I haven't explored any in-Tk rendering options yet, been too busy
> > with other projects.  Ideally I'd like to just render the asciidoc
> > markup directly, but I don't think anyone has done an asciidoc
> > viewer for Tk.  I can't imagine it would be that difficult to get
> > some sort of parser working though...
> > 
> > 
> 
> So, I took a stab at this earlier today, and it is fairly straight forward. I have 
> something that is semi working (I haven't tested all the scenarios yet), but 
> the rest is just really filling in the blanks.

Yea, I thought it would be really straight-forward.  The Tk text
widget is a really wonderful tool.  Makes these sorts things almost
write themselves...

> Question though: I was going to have a index tree on a side panel...but do
>  you want this thing to only bring up the git-gui.txt file, and show the table 
> of contents, or do you want all *.txt files in the index? Or .... ?

Yea, that's a good question.  I think I want all of that.  ;-)

I mean:

I'd like to be able to allow users to browse all of the Git manual pages and the user manual, directly from within git-gui. Then I can setup a new subcommand `git gui help commit` to bring up the git-commit manual page in this renderer (for example). So in that sense showing all of the manuals in an index is really useful. This may make it easier for some users (e.g me!) as they don't have to render the manuals, or rely upon the man/html branches from Junio.

I'd like to let users also browse the git user manual. This is a fairly large set of documentation, so the table of contents for this thing is not just a list; a proper tree that one can browse through is really nice.

And I'd like to start writing git-gui specific documentation, and let users browse through that as well.

So whatever you can provide is great. And you don't have to get everything at once either; just showing single files would be a great start. Showing single files with the various section headers in an "outline" view to the left would be even better.

I think one of the worst manuals we have is git-fast-import. Its huge. It uses a number of asciidoc features, and it has a fairly large outline. The user manual is actually a lot more complex, but isn't a single file manual page. ;-)

-- 
Shawn.