search

bcit-ci / CodeIgniter

Open Source PHP Framework (originally from EllisLab)
https://codeigniter.com/
MIT License
18.27k stars 7.6k forks source link

Keyboard shortcuts in user guide #1825

Closed metalmatze closed 9 years ago

metalmatze commented 12 years ago

Hey, I would really appreciate some keyboard shortcuts in the user guide. For example 't' for the table of content and '?' for a overview of all shortcuts.

I don't want to always have to click on 'Table of contents'. If someone is able to implement this with prototype, I'm not, I would really like it.

ckdarby commented 12 years ago

@MetalMatze Please create pull request

metalmatze commented 12 years ago

As I wrote I'm not able to code this...

BennyC commented 12 years ago

What type of shortcuts would you be interested in? Just similar ones to github? I'll take a look at this over the weekend, if someone isn't already taking a look!

metalmatze commented 12 years ago

Yep, like the ones here, on Bitbucket or 9gag ;-) The most important one would be a shortcut for opening the table of contents. That would be really cool!

alexbilbie commented 12 years ago

Just to chime in, someone from Ellislab is working on an updated design for the documentation - however as the new docs for v3 are based on Sphinx it should be possible to create a nice javascript powered documentation viewer reasonably easily

AkenRoberts commented 12 years ago

Keyboard shortcuts could be useful, though you'd really only need one or two. Finding specific shortcuts for individual sections would be difficult, and could potentially confuse users if they accidentally hit a key.

I'm glad a new design is in the works - I don't like the current one. I'd like to see a FAST way to access contents. Slow animation to open the ToC is a huge drag. Perhaps a relatively smart auto-complete text box that allows me to type something, hit the down key to get to my selection, then enter to load that page. THAT I would like.

metalmatze commented 12 years ago

Cool. I like your suggestion . Sounds good to me.

alexbilbie commented 12 years ago

I like the idea of hitting '/' - do it now on this Github issue and you'll see it goes to the issue search box

pickupman commented 12 years ago

I was able to get this work using a simple jquery block. I also added "h" as a hotkey to toggle the table of contents. Thoughts? Since this has to be added inside of every file in the user guide, any other thoughts for hotkeys to be added?

troymccormick commented 11 years ago

Hopefully not too far off topic but has anyone actually seen this new design of the user guide? Would love to at least get a glimpse of what is coming, and would love to help out if at all possible.

We just haven't heard a peep from EllisLab on this (or on CodeIgniter in general really...) for a long time... :-( Am I just not paying enough attention?

narfbg commented 11 years ago

@troymccormick While nightly builds of the user guide haven't been updated since late August, you can get a glimpse at http://codeigniter.com/nightly_user_guide/.

And of course you can build them yourself, using these instructions: https://github.com/EllisLab/CodeIgniter/blob/develop/user_guide_src/README.rst

AkenRoberts commented 11 years ago

For what it's worth, I'm pretty sure that isn't the final design of the new user guide.

troymccormick commented 11 years ago

@narfbg I knew that existed, but was told some time ago that it was just a "proof of concept" of getting them to run on Sphinx...which is maybe what @cryode heard also?

If that is the final design, count me on the list as disappointed in the design choices made... :-(

pickupman commented 11 years ago

I agree with @troymccormick . There was some mention in the last few months or so, that the final template was not done yet, but would be for the final 3.0 release. I've been referencing the new user guide for a while now and have gotten used to it. At some point the doctree was hidden, so it seems cumbersome linking back up to the TOC to find the reference you are looking for. A number of people have probably gotten used to the slide down tab. I think adding a toggle element or the hot key would be a good solution. Since the new docs are based on sphinx and a template, the doctree is already in the DOM.

pickupman commented 11 years ago

The nightly_user_guide link now redirects to the EllisLab / CodeIgniter home page. Any news when/where the nightly user guide can be found? I do build locally, but sometimes handy if working at another machine and don't have all of the dependencies installed for us Windows users.

The ExpressionEngine docs look like the CI nightlies, so I am guessing this will likely be the final design.

Build CI user guide using WAMP

narfbg commented 11 years ago

As I've already noted - the nightly builds haven't really been updated soon.

The guys from EllisLab recently said that they'll look into fixing that soon and AFAIK are still working on this big transition that you've just seen (with the new design and forums and stuff), so I'm sure they've got a lot of work on their hands. Hopefully, we'll have the nighties up soon again.

joellimberg commented 11 years ago

My quick comment: for me, the main problem with the current user guide is that it's a major inconvenience to constantly manually toggle the Table of Contents panel to move between sections. If that was somehow solved differently, there would really be no need for keyboard shortcuts.

AkenRoberts commented 11 years ago

I started a Github page with the nightly user guide: http://cryode.github.com/CodeIgniter It isn't automated right now, gonna make a cron for it when I get more spare time. But I'll keep it as up-to-date as I can.

narfbg commented 9 years ago

I've kept this as a "call for contributions" kind of issue, but after 3 years it's obvious that nobody is interested in submitting a patch, so closing.