Page MenuHomePhabricator

The help section should include a link to more help, ie. Help:Contents by default
Open, MediumPublic

Description

Author: ian

Description:
The help section gives the impression that it is comprehensive, but it is missing a lot. This either leads the user to believe many things are not possible which are, or is frustrating because it you read it all and think "help over, no more help available, but I can't find the syntax for strikethrough, what next? I'm confused."


Version: master
Severity: enhancement

Details

Reference
bz65797

Event Timeline

bzimport raised the priority of this task from to Medium.Nov 22 2014, 3:25 AM
bzimport added a project: WikiEditor.
bzimport set Reference to bz65797.
bzimport added a subscriber: Unknown Object (MLST).

The help section

How to find "the help section" (to make sure we talk about the same thing)? :)

ian wrote:

(In reply to Andre Klapper from comment #1)

The help section

How to find "the help section" (to make sure we talk about the same thing)?
:)

By help section, I mean in the WikiEditor, the link that says "Help", which opens a drop down with sections on the left, Formatting, Links, etc, within each has help explaining syntax.

Hmm, but not all wikis have/want much more explanation pages :) in my opinion the basic features are enough for in-editor help. For more a link in sidebar is better :)

ian wrote:

(In reply to Florian from comment #3)

Hmm, but not all wikis have/want much more explanation pages :)

I'm talking about choosing defaults. The fact that people can customize things does not have any special relevance to that, and that fact can seem to support pretty much any point. For example, if we add a help link to wikitools, they can customize it away if they don't want it.

in my
opinion the basic features are enough for in-editor help.

From an average user perspective, I would not call it basic. I would call it seemingly comprehensive. There are 8 separate help pages that pack a lot of information, over 180 works. Adding 1 link to that I don't think makes "not be basic".

For more a link in
sidebar is better :)

The link https://www.mediawiki.org/wiki/Help:Contents comes by default, which is a good idea, but the sidebar link location is a completely unintuitive place to go afte looking within the wikieditor help ui. A default wiki page has a lot of things going on, and when your attention directed within the square box of the wikieditor called Help, that link in the sidebar is not at all easy to find and visually is completely unrelated. And it may not even be there due to customization.

ian wrote:

  • I meant words, not works.

ian wrote:

Just want to add, I hope I did not sound harsh in my reply. I think wikieditor is a great extension. Just offering a suggestion to help it improve. Perhaps I will look into it's code at some point in the future.