Re: [fossil-users] looking for guinea pigs for new help functionality
On Fri, 22 Feb 2013, Stephan Beal wrote: > On Fri, Feb 22, 2013 at 10:11 AM, Sergei Gavrikov wrote: > I mean that new /help web page will be extra informative when > you add new volume "Available pages" to it. Perhaps, it is not > big issue for developers, but other can think then that Fossil > is too complex in every day usage :-) > > The current version of the branch separates the help into "Available > commands" and "Available pages." Or did you mean another level of > separation? > > Perhaps /helpx would be good place for extra help topics, but of > course, I do not resist on that. > > > It might be interesting to toggle the display of the auxiliary (help --aux) > commands and /www pages on and off with a JavaScript button. i don't really > want to split them into separate pages because it makes searching for a > command more difficult if you don't know off-hand which set it belongs to. Yes, I did mean to keep "Available pages" section on a separate page (e.g. /helpx), but if things become more complex (searching) *I revoke* this request. And really, JavaScript controls to hide/show extra topics is the best solution! Sergei > -- > - stephan beal > http://wanderinghorse.net/home/stephan/http://gplus.to/sgbeal > > ___ fossil-users mailing list fossil-users@lists.fossil-scm.org http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
Re: [fossil-users] looking for guinea pigs for new help functionality
On Fri, Feb 22, 2013 at 10:11 AM, Sergei Gavrikov wrote: > I mean that new /help web page will be extra informative when you add > new volume "Available pages" to it. Perhaps, it is not big issue for > developers, but other can think then that Fossil is too complex in every > day usage :-) > The current version of the branch separates the help into "Available commands" and "Available pages." Or did you mean another level of separation? > Perhaps /helpx would be good place for extra help topics, but of course, > I do not resist on that. > It might be interesting to toggle the display of the auxiliary (help --aux) commands and /www pages on and off with a JavaScript button. i don't really want to split them into separate pages because it makes searching for a command more difficult if you don't know off-hand which set it belongs to. -- - stephan beal http://wanderinghorse.net/home/stephan/ http://gplus.to/sgbeal ___ fossil-users mailing list fossil-users@lists.fossil-scm.org http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
Re: [fossil-users] looking for guinea pigs for new help functionality
On Fri, 22 Feb 2013, Stephan Beal wrote: > On Fri, Feb 22, 2013 at 8:06 AM, Sergei Gavrikov > wrote: > $0.02 > > Good morning, Sergei! > > - I would avoid that output of the base /help URL begins > itself too long (more than 1/2 of screen in $BROWSER), I would > just add "SEE ALSO" link on a bottom the Fossil's help page (as > man does). > > i'm not sure what you mean by that. I mean that new /help web page will be extra informative when you add new volume "Available pages" to it. Perhaps, it is not big issue for developers, but other can think then that Fossil is too complex in every day usage :-) fossil help help is something man man which points on all help topics (or manuals) Perhaps /helpx would be good place for extra help topics, but of course, I do not resist on that. > - Perhaps, it is logical to list new topics in the list > "Available pages" with "/" prefix as "/access_log", > "/admin_sql" and so on. > > At first it did, but it's really distracting to look at when this is > enabled. To turn it back on, edit main.c, line 1129, and replace (z+1) with > (z), then you'll see what i mean. Maybe it's just a matter of personal > taste. Agreed. > Thanks for the feedback! Thanks for new features! Sergei > -- > - stephan beal > http://wanderinghorse.net/home/stephan/http://gplus.to/sgbeal > > ___ fossil-users mailing list fossil-users@lists.fossil-scm.org http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
Re: [fossil-users] looking for guinea pigs for new help functionality
On Fri, Feb 22, 2013 at 8:06 AM, Sergei Gavrikov wrote: > $0.02 > Good morning, Sergei! > - I would avoid that output of the base /help URL begins itself too > long (more than 1/2 of screen in $BROWSER), I would just add "SEE > ALSO" link on a bottom the Fossil's help page (as man does). > i'm not sure what you mean by that. > - Perhaps, it is logical to list new topics in the list "Available > pages" with "/" prefix as "/access_log", "/admin_sql" and so on. > At first it did, but it's really distracting to look at when this is enabled. To turn it back on, edit main.c, line 1129, and replace (z+1) with (z), then you'll see what i mean. Maybe it's just a matter of personal taste. Thanks for the feedback! -- - stephan beal http://wanderinghorse.net/home/stephan/ http://gplus.to/sgbeal ___ fossil-users mailing list fossil-users@lists.fossil-scm.org http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
Re: [fossil-users] looking for guinea pigs for new help functionality
On Thu, 21 Feb 2013, Stephan Beal wrote: > Hiho, > i'm looking for guinea pigs again :), this time with minor enhancements to > the online help system: support for web page-specific help. (Most pages > don't have any useful help at the moment, though.) > > To try it out, check out the 'help-www' branch: > > http://fossil-scm.org/index.html/timeline?r=help-www [snip, see details http://www.mail-archive.com/fossil-users@lists.fossil-scm.org/msg11361.html] > If you have suggestions for improving this feature (and they don't > require a complete overhaul of the built-in help mechanism), please > feel free to voice them. Hi All looks great for me. Thanks for that new built-in help topics (very useful, otherwise users have to grep this list or Fossil sources). $0.02 - I would avoid that output of the base /help URL begins itself too long (more than 1/2 of screen in $BROWSER), I would just add "SEE ALSO" link on a bottom the Fossil's help page (as man does). - Perhaps, it is logical to list new topics in the list "Available pages" with "/" prefix as "/access_log", "/admin_sql" and so on. Regards, Sergei > -- > - stephan beal > http://wanderinghorse.net/home/stephan/http://gplus.to/sgbeal > > ___ fossil-users mailing list fossil-users@lists.fossil-scm.org http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
[fossil-users] looking for guinea pigs for new help functionality
Hiho, i'm looking for guinea pigs again :), this time with minor enhancements to the online help system: support for web page-specific help. (Most pages don't have any useful help at the moment, though.) To try it out, check out the 'help-www' branch: http://fossil-scm.org/index.html/timeline?r=help-www then: fossil help help reveals a new option: fossil help --www lists the available web pages. fossil help /pagename shows the help. Note that the / prefix is necessary to avoid ambiguities (e.g. /timeline vs timeline). e.g. stephan@tiny:~/cvs/fossil/fossil$ f help /timeline.rss | head URL: /timeline.rss?y=TYPE&n=LIMIT&tkt=UUID&tag=TAG&wiki=NAME&name=FILENAME Produce an RSS feed of the timeline. TYPE may be: all, ci (show checkins only), t (show tickets only), w (show wiki only). LIMIT is the number of items to show. ... It also handles ambiguous names: stephan@tiny:~/cvs/fossil/fossil$ f help /tkt ambiguous page prefix: /tkt Matching pages: /tktedit /tktsetup_editpage/tktsetup_timeline /tkthistory /tktsetup_keytplt /tktsetup_viewpage ... >From the UI, visit the /help page for a list of CLI commands (as before) and www pages (new). Alternately, visit /help?cmd=/pagename to jump right to the help, e.g. /help?cmd=/timeline.rss. If you have suggestions for improving this feature (and they don't require a complete overhaul of the built-in help mechanism), please feel free to voice them. -- - stephan beal http://wanderinghorse.net/home/stephan/ http://gplus.to/sgbeal ___ fossil-users mailing list fossil-users@lists.fossil-scm.org http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users
