search

hadley / helpr

An alternative html help system for R
31 stars 4 forks source link

help says how to alter style #24

Open tbates opened 13 years ago

tbates commented 13 years ago

it would be nice if the help said how to alter the style: Or perhaps this is a request for a flag to turn-off the big background PACKAGE NAME text

hadley commented 13 years ago

You can't alter the style unless you modify the package. What's the problem with the big background text? It should be barely visible.

tbates commented 13 years ago

Hi Hadley, On my machine it is high enough contrast to be distracting, especially as it also moves as you scroll, which is attention grabbing.

I'd much rather the background names wasn't there: clean is easy to read.

I feel a bit carping... And so I'll take this opportunity to say that the idea of a help system with built in user-information is great!

I wondered in using the system, whether too if instead of comments, it would be long-term more usable to put a wiki page underneath every help page?

Comments can't be integrated and edited, whereas a wiki page could really accumulate knowledge nicely - especially if the package takes off: being inside R is a great way to grab eyeballs!

Wikidot has a nice syntax. oh well...

hadley commented 13 years ago

We'd certainly consider adding a wiki, but the basic requirement is that someone has to provide a hosted service with the appropriate JS hooks so that we can easily add it to each page.

tbates commented 13 years ago

Thoughts

  1. http://www.revolutionanalytics.com/ might stick the pages on their site/sponsor helpr.com?
  2. http://helpr.wikidot.com/in ?
  3. github? Q: What's are the api/hook requirements? Could just ifframe it in?
hadley commented 13 years ago

Ideally, it needs to have a javascript hook that inserts into an arbitrary page, and the ability to specify some sort of page "id" since the url will differ between different computers. An iframe is a sub-optimal solution, particularly when we can't assume users don't have an internet connection.