From: Pratyush Yadav <me@yadavpratyush.com>
To: Philip Oakley <philipoakley@iee.email>
Cc: Birger Skogeng Pedersen <birger.sp@gmail.com>, git@vger.kernel.org
Subject: Re: [PATCH] git-gui: Add hotkeys to set widget focus
Date: Wed, 4 Sep 2019 03:48:51 +0530 [thread overview]
Message-ID: <20190903221851.gkbbvnrl72szwydx@yadavpratyush.com> (raw)
In-Reply-To: <ca5052b8-32ea-5d38-76ba-2389b5f95e45@iee.email>
On 02/09/19 06:23PM, Philip Oakley wrote:
> On 02/09/2019 13:25, Pratyush Yadav wrote:
> > On 01/09/19 11:27PM, Philip Oakley wrote:
> > > Hi Pratyus,
[snip]
> > > Are there any plans or thoughts about creating a more inclusive
> > > man page for
> > > the git-gui?
> > Having better documentation has been one of the things I have in my
> > future plans, but I can't really say when I can get to it depending on
> > my schedule and time available. I have a couple other topics active
> > which I'd like to get resolved first.
> >
> > Of course, if someone else is willing to take the initiative, I'm happy
> > to help :)
>
> The main aspect that would help for providing a contribution would be to at
> least decide the (rough) framework/format for a full Gui 'man page'. The
> existing one
> https://github.com/git/git/blob/master/Documentation/git-gui.txt is rather
> short. (would also need the sub-tree integration to be finessed)
>
> e.g.
> 1. how much should it be done via 'include' files (like the git-config man
> page now does include::config.txt[] and onwards).
>
> 2. Does it use the doc-book man-page format, or something akin to the former
> tutorial format? (everything appears to have shifted to the man page format,
> so looks like man format is the one.. [1,2,3,4]
>
> I'm thinking that, as it is a big job, it will need the documentation to be
> split over a number of small include files so that more folk can be
> contributors.
What exactly do you think we should document? From what I can see, the
major topics are "options", "key bindings", and "tools". Maybe also the
blame viewer.
If we do options inside the dialog with tooltips, that leaves key
bindings. If there is not much else, we might as well do it in the one
single man page we have, and worry about splitting later when it grows
in size.
If you intend to have a more comprehensive documentation where we
demonstrate the UI stuff, then using a man page will handicap us. In
that case a HTML page is a better idea. Although I'm not too sure what
warrants documentation is the general UI. It all seems pretty intuitive
to me, but them I am a "power user" so maybe I'm assuming too much.
> > For the options dialog, I think a "tooltip" (something like what you
> > get
> > when you hover over a image in a browser) that describes the option is a
> > better idea than having a separate man page. I don't expect the option
> > descriptions to be too long or complicated. This approach has the added
> > benefit of not having to maintain a separate man page. Whenever someone
> > adds a new options, they have to add its description as well.
> A tool tip that says 'see git help config.. ' could be done. Any pointers to
> an existing one for trying a cookie cutter approach getting started on those
> ones?
The "Choose a revision" dialog shows a tooltip. You can get it by
creating a tool with the "Ask the user to select a revision" option
selected. Look in lib/choose_rev.tcl.
The blame viewer also uses tooltips. When you hover over a line, it
shows the commit message of the last commit that touched it. Look in
lib/blame.tcl.
Then there is Tk's tooltip package [0]. I haven't used it, so can't
really say what the differences are, and which is better.
If you do end up using the tooltip implemented in choose_rev.tcl and
blame.tcl, I think it is a good idea to move the common tooltip code in
a "tooltip framework".
Although I understand that it is a lot of work (especially if you decide
to refactor the existing tooltip code), and not exactly documentation,
so it might not be what you want to do.
[0] https://core.tcl-lang.org/tklib/doc/trunk/embedded/www/tklib/files/modules/tooltip/tooltip.html
--
Regards,
Pratyush Yadav
next prev parent reply other threads:[~2019-09-03 22:18 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-20 13:32 git-gui, feature request: add hotkeys to focus different widgets Birger Skogeng Pedersen
2018-02-23 10:22 ` [PATCH] git-gui: Add hotkeys to change focus between ui widgets Birger Skogeng Pedersen
2018-02-23 16:42 ` Birger Skogeng Pedersen
2018-02-28 12:10 ` Birger Skogeng Pedersen
2018-03-05 16:55 ` Johannes Schindelin
2018-03-06 14:35 ` Birger Skogeng Pedersen
2018-03-06 19:28 ` Junio C Hamano
2019-08-31 12:23 ` [PATCH] git-gui: Add hotkeys to set widget focus Birger Skogeng Pedersen
2019-08-31 12:27 ` Birger Skogeng Pedersen
2019-09-01 11:32 ` Pratyush Yadav
2019-09-01 16:21 ` Junio C Hamano
2019-09-01 18:24 ` Birger Skogeng Pedersen
2019-09-01 19:01 ` Bert Wesarg
2019-09-01 19:36 ` [PATCH] " Birger Skogeng Pedersen
2019-09-02 18:19 ` Pratyush Yadav
2019-09-02 18:35 ` Birger Skogeng Pedersen
2019-09-02 18:53 ` Pratyush Yadav
2019-09-02 19:05 ` Birger Skogeng Pedersen
2019-09-02 19:42 ` Bert Wesarg
2019-09-03 14:21 ` Birger Skogeng Pedersen
2019-09-03 14:22 ` Pratyush Yadav
2019-09-03 14:45 ` [PATCH] git-gui: use path name instead of list index to track last clicked file Pratyush Yadav
2019-09-03 18:07 ` [PATCH v4] git-gui: Add hotkeys to set widget focus Birger Skogeng Pedersen
2019-09-03 18:13 ` Birger Skogeng Pedersen
2019-09-03 19:30 ` Birger Skogeng Pedersen
2019-09-03 21:49 ` Pratyush Yadav
2019-09-04 14:30 ` [PATCH v5] " Birger Skogeng Pedersen
2019-09-04 18:59 ` Johannes Sixt
2019-09-04 19:20 ` Birger Skogeng Pedersen
2019-09-04 21:39 ` Johannes Sixt
2019-09-04 22:31 ` Pratyush Yadav
2019-09-04 23:38 ` Junio C Hamano
2019-09-05 12:33 ` Pratyush Yadav
2019-09-04 19:55 ` Bert Wesarg
2019-09-04 21:45 ` Johannes Sixt
2019-09-10 19:12 ` Pratyush Yadav
2019-09-11 6:49 ` Birger Skogeng Pedersen
2019-09-11 17:48 ` Pratyush Yadav
2019-09-11 18:11 ` Johannes Sixt
2019-09-03 16:06 ` [PATCH] [PATCH] " Bert Wesarg
2019-09-01 22:27 ` Philip Oakley
2019-09-02 12:25 ` Pratyush Yadav
2019-09-02 17:23 ` Philip Oakley
2019-09-03 22:18 ` Pratyush Yadav [this message]
2019-09-01 18:58 ` Bert Wesarg
2019-09-01 19:25 ` Birger Skogeng Pedersen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190903221851.gkbbvnrl72szwydx@yadavpratyush.com \
--to=me@yadavpratyush.com \
--cc=birger.sp@gmail.com \
--cc=git@vger.kernel.org \
--cc=philipoakley@iee.email \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).