Help Screens - Administrator - Joomla! 1.0.x Updating

[humvee]

Hi all,

Just to let people know I am working through the Help screens for the 1.0.x version of Joomla! to try and get them up to 1.0.12 level as quickly as possible.

These are the screens that are available within Joomla! itself as well as from the http://help.joomla.org site.

Note: For progress updates please see: Information & Changelog

If anyone has any content that they feel would be appropriate please let me know.

Items that are new or updated will - whilst the whole thing is completed - be marked with a double asterisk '**' in the menu title. Those that are work in progress will have WIP marked as well. Those that have not been reviewed yet will be 'unmarked'.

I am looking to standardize the format, style, and layout, as well as update existing content and include new content where needed.

Regards

Andy

[Michelle Bisson]

Thanks Andy!  I hope that there will be some who are willing to write any missing content with you.

[humvee]

Please note that a number of the screens have been published without any content, or just initial Work In Progress (WIP) labels. This is just whilst I try to get everything competed as quickly (and ultimately accurately) as possible.

The titles marked with **WIP are in the process of being updated.
In these cases the content is not fully verified and should be checked out.

This will be replaced with **NEW when the content is completed.

Sorry for any confusion this might cause.

Andy

[Michelle Bisson]

Andy,

Thanks for the update!

[humvee]

Hi,

Just an update.

The structure of the 1.0.x. Help Screens has now been modified to match the sequence and content of the menu (topmenu) in a Joomla! installation.

All the sub-menus of the menu now have representative pages in the Help Screen series. Some are still empty of Content but were needed as placeholders.

A lot of the pages have been partially edited but I am pleased to say that the Site menu section has been completed and all the following Content Items have been updated/renewed/created. (they are marked as **NEW** in the Help Screens for now).

• Global Configuration
• Language Manager
• Language Editor
• Media Manager
• Preview
• Statistics
• Search Engine Text
• Template Manager [ Site ]
• Template Manager [ Site ] - Assign
• Template Manager [ Administrator ]
• Template Managers CSS Editor
• Template Managers HTML Editor
• Module Positions
• Trash Manager
• User Manager
• User Manager [ User : Edit ]
• User Manager [ User : Add ]

If anyone finds any needed corrections or missing content then please post your comments below:

Many thanks

Andy

[leadict]

This is a great job. It supposes a new full structure for help screens.

Those changes could affect too to the key references for remote access.

Will Joomla 1.0.12 include the new help screen structure?

[humvee]

Hi leadict,

Will Joomla 1.0.12 include the new help screen structure?

It is hoped that the new structure may be included within the future release of 1.0.12.

However, there may be time constraints in achieving this as I was fairly late in arriving at the party with this project which does entail some additional and unplanned work for the Dev Team if they can manage to fit it in, but I certainly have no wish for 1.0.12/1.5 to be delayed for the Help Screens!! - not that I expect they would delay for this.

Those changes could affect too to the key references for remote access.

I was very mindful of this and I have made the changes in such a way that the majority (I haven't finished checking them all yet) of existing key references are still linked to their original documents albeit that document titles will have been updated the actual Content subject still relates to the original topic.

There are some of the extraneous links that were already broken that I am unable to resolve but that is a separate and hopefully minor point.

The original release of the Help Screens within Joomla! 1.0.x was approx 50 pages there are now going to be more than 160! To avoid this being a major stumbling block I have been and will continue to be adding the Related Information section - as shown by the current crop of completed documents - to each page. These show the links to associated processes/screens so that there is a direct thread between old and new Content as well as additional information resources where appropriate.

One of the key factors overall was however to ensure that the Help Screens for 1.0.x. that are available were completed and brought right up to date for 1.0.11 and subsequently for the hopefully soon to be released final 1.0.12.

If it is not possible to fully update all the Help Screen key references the Content is still going to be available on the Help Portal and it is (hopefully) now available in a more intuitive layout. Certainly it will be more complete than it was before.

I hope this answers your questions/concerns,

Regards

Andy

[humvee]

Hi

I have already been approached by one of the Official Translation teams asking whether a document format of the Help Screens will be available.

I would confirm that this was already a part of the overall plan - to be available as M$ Word or OOo Writer format (or other if I can work out how ) for the Official Translation Teams (partners)  as well as an interactive .PDF download for other Users to have/print off.

Obviously my first priority is to ensure the Content gets written but I will release these documents as soon as possible.

Regards

Andy

[Markku]

Sure thing, and thanks for the info, Andy!

[Michelle Bisson]

I have already been approached by one of the Official Translation teams asking whether a document format of the Help Screens will be available.

All people interested in translating the Help Site documents,need to contact David Gal, the Translation Work Group Coordinator on the Translation Forum
http://forum.joomla.org/index.php/board,11.0.html

[Chris Davenport]

Hey, if you guys need a hand getting the 1.0.12 help screens proof-read then just give me a shout.  I'm aware of how short time is, so if an extra pair of eyeballs can be of assistance, I can put the Dev Doc stuff on hold for a bit........ 

Regards,
Chris.

[humvee]

Hi Chris,

Thanks very much for the offer by all means taking a look at the Help Screens for proof reading will be a great help.

The actual creation of the screen Content is an ongoing process at the moment, but I have created "place holder" documents so that at least the key references can be created - if possible - by the Devs  which will mean the editing/creation of Content can continue after the release of 1.0.12 if necessary albeit at the moment the links will point to empty screens or WIP.

The screens that are ready for proof reading/commentary are those in the Help Portal marked as **NEW**. Everything else is very much work in progress.

As I said above the Site section http://help.joomla.org/content/category/16/100/222/ is completed. I am just working my way through the rest, as quickly as possible, in some sort of logical way (at least logical to me :P).

Let me know what you think etc.

Thanks

Andy

[Chris Davenport]

Okay Andy, do you want me to make changes directly and log what I've done somewhere, or do would you prefer me to suggest changes for someone else to apply?

Regards,
Chris.

[humvee]

Hi Chris

Could you post them and then I can make sure that any changes are also incorporated into new pages when they are created. (note the someone else is me ... just me )

I have created a separate page for this purpose:

http://forum.joomla.org/index.php/topic,121104.0.html

Once again many thanks

Andy

[humvee]

Hi,

Just a quick update on progress so far:

Proof Reading:
Firstly big thanks go to Chris Davenport for his efforts in doing a final Proof Reading run on the many completed screens so far.

Joomla! 1.0.12 Help File Inclusion in new release
Secondly, big thanks go to RobS (Rob Schley) of Q&T whose extra efforts meant getting the new screens into the new 1.0.12 release of Joomla! at least as far as on the Menu=>Help Menu Item. Chris Davenport also assisted here in getting revised link pages for the Core files completed thus removing the outdated and very incomplete original Core Help files. There is a hope to get the new screens issued as some sort of optional patch once they are all completed to 1.0.12 status.

Latest Position in the Update Programme

So far the following screens have been completed - some are still subject to final proof reading:
   

• Global Configuration
• Language Manager
• Language Editor
• Media Manager
• Preview
• Statistics
• Search Engine Text
• Template Manager [ Site ]
• Template Manager [ Site ] - Assign
• Template Manager [ Administrator ]
• Template Managers CSS Editor
• Template Managers HTML Editor
• Module Positions
• Trash Manager
• User Manager
• User Manager [ User : Edit ]
• User Manager [ User : Add ]
• Install new Template [ Site ]
• Install new Template [ Administrator ]
• Install new Language - Site
• Install/Uninstall Components, Modules and Mambots
• Install New Components and Manage Installed Components
• Install New Modules and Manage Installed Modules
• Install New Mambots and Manage Installed Mambots
• Help

• Version Check
• System Information
• Global Check-in
• Messages Inbox
• Messages Configuration
• Menus - What are they?
• Menu Manager
• Menu Manager: Copy Menu
• Menu Manager: New / Edit Menu
• Menu Manager [ mainmenu ]
• Menu Manager: [ usermenu ]
• Menu Manager [ othermenu ]
• Menu Manager [ topmenu ]
• Menu Manager [ menuname ] - Add Menu Item
• Menu Manager [ menuname ] - Edit Menu Item
• Menu Manager [ menuname ] - Copy Menu Items
• Menu Manager [ menuname ] - Move Menu Items
• Add Menu Item :: Component
• Add / Edit Menu Item :: Component [ Web Links ]
• Add / Edit Menu Item :: Component [ Contacts ]
• Add / Edit Menu Item :: Component [ Search ]
• Add / Edit Menu Item :: Component [ News Feeds]
• Add / Edit Menu Item :: Component [ Polls ]
• Add / Edit Menu Item :: Component [ Login ]

So about a third of the way through :P

What's Next?
More of the same.
Provisional layout templates have now been added to all pages and a significant number of the graphics files are now completed.

Regards

Andy

[Michelle Bisson]

Thanks Andy and Chris for all the hard work editing and proof-reading the Help Screens 1.0.x!

[humvee]

Hi

Just to provide an update of progress since the last one...

The following screens have now been completed. Again pending any final proof reading.


CC License,

What's New in 1.0.x,

Helpful Information 1.0.12.

Content Item Manager

Table - Web Link

Link - URL

Content What is it?,

Support,

Credits,

Glossary 1.0.12,

Menu Items Link Content Item,

Link Static Content Item,

List Content Section,

Link News Feed,

Table - Contact Category

Table - Content Category

Menu Items Submit Content
                Link - Component Item,

Link - Contact Item

Blog - Content Section Archive

Blog - Content Section

Blog - Content Category,

Blog Content Category Archive,

Wrapper

Content by Section + sub-menus

Content Item Manager

Content Item Manager:

Content Item : New / Edit

Content Item Manager :: Move Content Items

Content Item Manager :: Copy Content Items

Static Content Manager

Static Content Item New / Edit

Separator / Placeholder, 

Further work continues and will be updated in due course.

Regards

Andy

ps If any one has chance to look at any of the completed screens listed here and below and have any comments, suggestions then please post these at the following link: http://forum.joomla.org/index.php/topic,115661.0.html

[humvee]

Hi

Content Menu - Help Screens section completed (subject to final proof reading)

Please post any suggestions, corrections, or comments in the following thread:

http://forum.joomla.org/index.php/topic,121104.0.html

Regards

Andy

[humvee]

Hi,

Component Menu Help Screens section completed (subject to final proof reading)

Please post any suggestions, corrections, or comments in the following thread:

http://forum.joomla.org/index.php/topic,121104.0.html

Many Thanks

Andy

[brian]

keep up the good wrk. it cant be fun doing it on your own

[humvee]

Hi Brian

Thanks for the encouragement ...Let's just say it has its moments :P

Andy

[humvee]

Hi

Further update Menu=>Module Site and Administrator all screens competed.

That's now 153 completed screens and just 24 to go!

Andy

[Chris Davenport]

That's fantastic Andy.  Well done.  The end is in sight!

Regards,
Chris.

[Markku]

Andy, you’ve done tremendous work, much appreciated!

Best,

- Markku

[humvee]

Right that's it - well pretty much.

All 177 screens have now been completed. There are in excess of 350 individual images that have been created to cover the various screenshots and displays including the various toolbar images, and icons.

Final read through and some adjustments to titles etc in keeping with suggestions that have been made still to do.

Once that is completed  the next step will be to produce a patch pack of the screens for people to add to their Joomla! installs - assuming they want to  . This will ensure that the Help Screens are once again available when offline.

I would be interested to hear peoples thoughts on whether the image files should be included as part of the pack or whether the size of the image directory at just over 4MB is prohibitive. If that is the case I would propose a text only install patch pack (or even both??).

There will also be - all being well - a PDF version of the help screens that will be downloadable from the Help Site.

Any additional content that is deemed appropriate/necessary will be added to the soon to be updated Admin and User Manuals.

Regards

Andy

[Chris Davenport]

Hi Andy,

Once that is completed  the next step will be to produce a patch pack of the screens for people to add to their Joomla! installs - assuming they want to  .

Me, for one.

I would be interested to hear peoples thoughts on whether the image files should be included as part of the pack or whether the size of the image directory at just over 4MB is prohibitive. If that is the case I would propose a text only install patch pack (or even both??).

I think image files should be included.  4Mb is not that big nowadays.

Excellent work, Andy.  A job well done.

Regards,
Chris.

[leadict]

Hi Andy,

You have done a great job by finishing the bulk of the update.

About the images (for the help pack), you could think on this:

1. The images of: toolbar, icons, template style and site screenshots, are all useful.

2. The screenshots of Administrator are less useful, because you are working over it (unless you are viewing the help wrapped).

[humvee]

Hi all,

We are currently completing the final review of the screens in preparation for their release to the community.

Watch this space for an announcement shortly.

Regards

Andy