Use About or Introduction

redndahead's picture

As I was adding help pages I noticed that the ones that had already been added were titled About Modulename. I was titling mine Introduction. So 2 questions:

  1. What's better About or Introduction?
  2. I had removed the module name from the title because it will automatically be within the module group. Should we keep the module name or should it go?
Groups:
Login to post comments

Maybe visit

yoroy's picture
yoroy - Sat, 2008-12-06 09:40

Maybe visit http://groups.drupal.org/tracker for a second. I don't know this scenario will happen within the help system, but currently about 20 posts all titled "Introduction" are listed there. I was going to edit all and rename them to add the module names because only "Introduction" has no meaning and then found this post :-)

So I'd very much prefer to keep the module name in the title.


Maybe For Posts Here

redndahead's picture
redndahead - Sat, 2008-12-06 21:10

We can do it for posts here, but in the help system you would have a group like this

Users
Introduction to Users
Add Users
Delete Users

or

Users
Introduction
Add
Delete

If we choose the second version then we'll just have to remember to remove the module names in the titles when we are moving help from this group to the module.


Consolidate About $foo

keith.smith's picture
keith.smith - Sat, 2008-12-06 23:25

I tell you, after taking redndahead's excellent work and packaging up the about.html files for the core help, I'm thinking that maybe we should not have topics created as they currently are. I'm thinking we should have one "About" topic list, with all the magically-named about.html files providing "About $foo" in this one list. Or really, if the entire topic list is "About", I guess these could all be titled just "$foo".

I'd like the new topic-based help, which we'll have to add in another issue, to really stand out though. Either grouped together in a few topics, or primarily in a single topic named "How To". Then contrib, if it wants to add additional topics, override one of the existing topics or entries, or insert entries in the index of "About" or "How To", it can do so.


Need to reflect in the patch

Gurpartap Singh's picture
Gurpartap Singh - Sun, 2008-12-07 05:37

Whatever change is decided here will need to reflect in the help system patch, since that magically included about.html's title is set to "About $foo".

I'm fine with the title "Introduction", that provides what it's name suggests but when I had set the title as "About $foo", I imagined it to contain what a mini/short README.txt files contain today. Bah. I like both.