Online (yelp) Help System

Write suggestions and new ideas in here
More ideas here http://community.linuxmint.com/idea/welcome
Forum rules
No support questions here please.
Do not post ideas for application developers. Please use GitHub for Cinnamon and Nemo ideas.

Online (yelp) Help System

Postby Purrmaster on Sat Jul 09, 2011 7:27 am

I've been trying out Mint and it is impressive. The user friendliness is good and the thing just.... works.

One thing seems to be missing though and that's an in the OS help system. Or more to the point, Help files. Online (by online I don't mean Internet based) help systems are common in commercial operating systems. I think Mint would benefit from such a thing.

As I understand it, there is already a help program (I think it's called GNU yelp or something) that looks pretty polished. It's just the written documentation itself that needs to be put together.

The first place help files would be good to have is the Control Center. The help files could probably be fairly short but still be useful.

I'm aware that this is probably much easier said than done. And perhaps it isn't feasible. If the developers need someone to help write the documentation, I volunteer. I suspect it would take many people to get the help files written up and a few more to format them for yelp. But if you need another documentation writer, I'd be happy to help out, if you need it.
Purrmaster
Level 1
Level 1
 
Posts: 11
Joined: Mon Jul 04, 2011 3:43 pm

Linux Mint is funded by ads and donations.
 

Re: Online (yelp) Help System

Postby Habitual on Sat Jul 09, 2011 8:00 am

this work on your system?
Code: Select all
yelp man:date
What's a landing but a take off in reverse?
User avatar
Habitual
Level 8
Level 8
 
Posts: 2243
Joined: Sun Nov 21, 2010 8:31 pm
Location: LM17Q-Xfce

Re: Online (yelp) Help System

Postby Purrmaster on Sat Jul 09, 2011 9:27 pm

I'll check once I boot it up. Is this a way of telling me there are such help files that I simply haven't found?
Purrmaster
Level 1
Level 1
 
Posts: 11
Joined: Mon Jul 04, 2011 3:43 pm

Re: Online (yelp) Help System

Postby Habitual on Sun Jul 10, 2011 9:03 am

Sure is:
Terminal >
Code: Select all
env | grep -i manpath

Mine is MANPATH=/usr/local/man:/usr/share/man

but I'm on another distro (OpenSUSE)
my 10.10 LTS VM tho' spits back nothing from that command, as the user or root.


try this also:
Code: Select all
grep MANDB_MAP /etc/manpath.config

outputs on my 10.10 LTS VM
Code: Select all
# MANDB_MAP      global_manpath   [relative_catpath]
MANDB_MAP   /usr/man      /var/cache/man/fsstnd
MANDB_MAP   /usr/share/man      /var/cache/man
MANDB_MAP   /usr/local/man      /var/cache/man/oldlocal
MANDB_MAP   /usr/local/share/man   /var/cache/man/local
MANDB_MAP   /usr/X11R6/man      /var/cache/man/X11R6
MANDB_MAP   /opt/man      /var/cache/man/opt


YMMV but if it does, we'll dial it in.
Don't despair!
What's a landing but a take off in reverse?
User avatar
Habitual
Level 8
Level 8
 
Posts: 2243
Joined: Sun Nov 21, 2010 8:31 pm
Location: LM17Q-Xfce

Re: Online (yelp) Help System

Postby Purrmaster on Sun Jul 10, 2011 3:34 pm

I see now. Yelp can display manual pages.

Manual pages are good, no doubt about that. But I was thinking something more along the lines of help files for things like Control Center. I.e. You click on the question mark or "help" icon and it pops up something like:

"Welcome to Mint control center. This is where you can customize Mint to suit your preferences. Click on a heading to get more information about each control:

(Hyperlink to Appearance)

Appearance. You can use Appearance to change the way your computer looks and feels.

Theme lets you choose from a number of premade looks for your computer. You can choose from the themes already present, download new themes from the Internet, or customize a theme to your liking......."

And then you have a brief, hyperlinked walkthrough on Themes.

That's kind of what I had in mind. As I said, I'm sure this is way easier said than done. Writing and formatting the documents would probably be time consuming. But if something like it could be put together, I think it would help out Mint, in general.

I didn't want to sound selfish, so that's why I offered to help with some writing.

Man pages are great if you are using command line stuff. But I think GUI specific help files, easily accessed by a mouse click or F1, would be grand.
Purrmaster
Level 1
Level 1
 
Posts: 11
Joined: Mon Jul 04, 2011 3:43 pm

Re: Online (yelp) Help System

Postby Habitual on Sun Jul 10, 2011 3:48 pm

I'm on OpenSUSE and we have that already. :)

http://susepaste.org/28146043
and clicking that Help button gives me http://susepaste.org/80691402

I couldn't agree more re:"I think it would help out Mint"
What's a landing but a take off in reverse?
User avatar
Habitual
Level 8
Level 8
 
Posts: 2243
Joined: Sun Nov 21, 2010 8:31 pm
Location: LM17Q-Xfce

Re: Online (yelp) Help System

Postby Purrmaster on Sun Jul 10, 2011 11:01 pm

Links to web or wiki pages would be ok, but I think it would be preferable to have help files that are stored locally and therefore accessible offline.

As I said, I'd be happy to help out, if it's wanted. But I realize that this may be an idea that is just impractical at this juncture. I could try a quick and dirty write up of something but I'd have to study the UI in great detail first.
Purrmaster
Level 1
Level 1
 
Posts: 11
Joined: Mon Jul 04, 2011 3:43 pm

Re: Online (yelp) Help System

Postby netherstar on Tue Dec 27, 2011 10:36 pm

On my Linux Mint 11 system the help files are in /usr/share/gnome/help, but I cannot access the files from within the program (help | contents).
If I navigate to the en_GB folder under a program name subdirectory I can use yelp to show the help file (yelp openshot.xml)
netherstar
Level 1
Level 1
 
Posts: 3
Joined: Tue Dec 27, 2011 10:28 pm

Re: Online (yelp) Help System

Postby netherstar on Tue Dec 27, 2011 11:03 pm

Check out "Re:Help With Help" on this forum.
Post by Vincent Vermeulen on Sept 4, 2011.
netherstar
Level 1
Level 1
 
Posts: 3
Joined: Tue Dec 27, 2011 10:28 pm

Linux Mint is funded by ads and donations.
 

Return to Suggestions & New Ideas

Who is online

Users browsing this forum: No registered users and 1 guest