The Joomla! Forum ™

Please post any corrections, suggestions for the current programme of updating the Help Screens for Joomla! 1.0.x here.

Thanks

Andy

Starting at random....

Banners - What are they? http://help.joomla.org/content/view/1674/153/
Change: The Clients are the individuals or organisations by whom the Banner has been submitted and to whose we site the Banner links.
To: The Clients are the individuals or organisations who have submitted the Banners and to whose web sites the Banners link.

Banner Manager: New/Edit http://help.joomla.org/content/view/267/153/
Some obvious stuff missing from the top, but...

Change: Saves the content and returns to Manager.
To: Saves the content and returns to the Banner Manager.

Change: Enter the number of times to display to banner into the input field, or tick the "Unlimited" checkbox for unlimited display.
To: Enter the number of times to display the banner into the input field, or tick the "Unlimited" checkbox for unlimited display.

Change: Banner URL:
To: Banner Image Selector:
(So it matches what is actually displayed on this screen).

Change: Custom banner code:  You may enter here some code (See Developper Manual for more information).
To: Custom banner code:  You may enter here some code (See Developper Manual for more information).

Change: Banner Image: Image selected under "Banner URL" is displayed here for your convenience.
To: Banner Image: Image selected under "Banner URL" is displayed here for your convenience.

Is this okay Andy?

Taking a break.  Back later (I hope).

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Hi Chris,

The Banners What are They and others are not in the Site section which is the one to date that is complete. See my post on the other forum. Only those items marked **NEW** are completed.
I have not worked on or completed those marked **WIP they are early stage only.

Thx

Andy

Silly me.  For some ridiculous reason I'd read that as meaning to stay away from the Site section. 

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Probably more a case of me doing things differently to what you are you used to, I just went with my own 'system' not knowing anything different! Sorry for any confusion.

Andy

Hopefully on the right track now. 

Global configuration: Page 1 perfect

Global configuration: Site Tab: http://help.joomla.org/content/view/51/153/1/1/

Change: This facility is ideally used when updating or installing templates, extensions, or data, and do not wish to have your visitors view the site until the changes are completed.
To: This facility is ideally used when updating or installing templates, extensions, or data, and you do not wish to have your visitors view the site until the changes are completed.

Change (for consistency with usage later on this page): It is also possible to edit the Site is Unavailable display by direct editing of the HTML within the offline.php file in the root/ directory of the Joomla! installation on the web server.
To: It is also possible to edit the Site is Unavailable display by direct editing of the HTML within the offline.php file in the Joomla_root/ directory of the Joomla! installation on the web server.

Missing close bracket in: Select the No option to return the web site to normal viewing accessibility (remembering to first check the “Override write protection while saving“ check box within the Global Configuration panel.

Maybe change: Offline Message: When the Site Offline Yes option is selected the content of this field forms the basis
To: Offline Message: When the Site Offline field is set to Yes the content of this field forms the basis

Suggest change: Include a link or e-mail address so that the problem can be reported as there is often chance that the site administrators(s) do not know about it.
To: Include a link or e-mail address so that the problem can be reported as there is often a chance that the site administrator does not know about it.

Try changing:  %%SITENAME; ?>%%
To: <?php echo $_CONFIG->SITENAME; ?>
That should prevent Joomla! executing the code.  If it works then the following Note can be removed.

Link to "Login Form Module" under "Frontend Login:" is broken (maybe hasn't been written yet?).

Change: Require Unique Email: Select whether you want to prevent registration with duplicate e-mail addresses. In combination with User activation this option prevents Users to sign up several times using the same e-mail address.
To: Require Unique Email: Select whether you want to prevent registration with duplicate e-mail addresses. In combination with User activation this option prevents Users from signing up several times using the same e-mail address.

Change: Debug Site: Setting this to Yes allows error messages that are created by the web site's php installation and MySQL database errors to be displayed.
To: Debug Site: Setting this to Yes allows PHP and database error messages to be displayed.

Change: If allowed, in the Frontend User Params setting above, Users may still select their own preference, but until they do then this is the editor that will be set for them.
To: If Frontend User Params (see above) is set to Yes then Users may select their own preference, overriding this default selection.

Change: The image is - by default - called favicon.ico and is located in the Joomla! Root/Images directory of the installation.
To: The image is, by default, called favicon.ico and is located in the Joomla_root/images directory of the installation.
Note the lower case "i" in "images".  Probably irrelevant on Windows machines, but important on Linux boxes!

Phew!  Hope I'm not being too picky. 

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Global Configuration: Locale tab: http://help.joomla.org/content/view/51/153/1/2/

Under "Language" change: See Install new language - Site. Select the required language from the drop down list.
To: See Install/Uninstall a Language File. Select the required language from the drop down list.
Reason: To match the title of the page actually linked to.

Okay, I'm confused about the time fields.  It appears that the "time offset" field is not used by the Joomla! core code except that if you change it and save it also changes the "server offset" field.  Could be used by 3PD extensions though maybe?  And why is the "server offset" a read-only field?  Since I live in the UK and always operate in GMT I have no experience of stretching a site over timezones.  I think someone else needs to review this page.

Global Configuration: Content Tab: http://help.joomla.org/content/view/51/153/1/3/

Change: Control who can vote in the Front-end using the the Access Level variable in Site Mambot: [ MOS Rating ].
To: You can control who can vote in the Front-end using the Access Level variable in Site Mambot: [ MOS Rating ].

Change (for consistency): NOTE: The PDF Maker will be unavailable if the Media directory is not writable.
To: NOTE: The PDF Maker will be unavailable if the Joomla_root/media directory is not writable.

The link to "Site Mambot [ MOS Pagination]" under "Table of Contents on multi-page items" actually takes you to a different page!

In: Content Item Navigation: Choose the radio button Show, to publish...
The "Show" should be in italics for consistency.

Okay, that's all I have time for right now.  If my broadband connection at home gets activated (it was due yesterday but didn't happen), then I'll do some more over the weekend.

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Totally!


A one off I fear!!

Done! The intention is to use the imperative, and active, voices/styles(whatever) wherever possible so I have re-written all the entries with 'you' or 'your' in them. i just have to remember to keep it going through the rest...


Done! Going to go with joomla_root/images etc so as to maintain the lowercase consistency on this one as you rightly pointed out elsewhere.



Done!



Done! With additional rewording.



Done!



Done!
Thanks for this. As per a separate post I made in the Work Group forum is there a proven way of entering {...} curly brackets without code being actioned? I have tried with the hexadecimal code but this did not work.



Done! It is weird every so often a link does not register properly despite going through the same process each time.



Done! With additional change ...from signing up more than once using the same e-mail address.!



Done!



Done!



Done!



Not at all - with the amount of time I am spending on  it I want the end result to be right!!

Thanks

Andy

Added an advisory note for time being. The link in the document is correct it was the page title I had not got around to changing.

Andy

Absolutely agree if there is something not right...I will post separately in WG Lounge.


Not changed.


Done



Done
Had changed this before but it seems that JCE does not like it when a URL is changed. So existing link must be 'broken' first and then a new one created.



Done.

Thanks Chris

Global Configuration: Database Tab: http://help.joomla.org/content/view/51/153/1/4/

Suggest replace paragraph: MySQL Password: This is the password - entered during the installation of Joomla! - that together with the Username above, is used to access the MySQL database upon which Joomla! stores its data. Do not edit this setting unless absolutely necessary.
With: (Warning icon) For security reasons it is not possible to change the MySQL password from within Joomla!  If the new MySQL username also requires a new password then make sure that you know how to make amendments to your configuration.php file before making the change.  If the MySQL username and password combination are not correct then your Joomla! website will be inoperable until you can amend configuration.php with a valid username and password combination.

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Global Configuration: Server Tab: http://help.joomla.org/content/view/51/153/1/5/

Change: Absolute Path: This is the route to the location of the root directory of the Joomla! installation on the web server. The information used by Joomla! to orientate it to the surrounding system. It will be necessary to edit this setting if, for example, due to changing server hosts, or when uploading a site from a local web server to an online web server.

To: Absolute Path: This is the path to the root directory of the Joomla! installation (referred to as joomla_root/) in the web servers filesystem. It will be necessary to edit this setting if, for example, you are changing server hosts, or when uploading a site from a local web server to an online web server.

Change: Warning: If it was necessary to create the config.php file from the config.php-dist file included with every installation of Joomla! then it is recommended to edit the default Secret Word to something else to make the installation more secure.
To: Warning: If it was necessary to create the configuration.php file from the configuration.php-dist file included with every installation of Joomla! then it is recommended to edit the default Secret Word to something else to make the installation more secure.

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Hi Chris,

Reviewed this whole section and made overall changes to (hopefully) make it clearer.

Andy

Done with variation.



Done... why is it no matter how many times you reread a document you can miss the obvious

Thx

Andy

Yes, I am new to the forum, but I am not shy about jumping in.

I am with a national non-profit organizatiion (NPO in the U.S., NGO in most other countries), and to help us (especially me, since I oversee the Web development) maintain integrity of the site, we have been experimenting with about eight different CMS platforms for about two months, and right now it is down to Joomla and two others.

One thing that's been a constant bug in my ear from several people involved in the internal testing is that the descriptions don't always give detailed information.  One case in point: the Help screen for the Weblink Manager.  Right now, since there's only about seven people using the interface, the problem is resolved.  Because we are a non-profit, we often have volunteers involved in a lot of different activities, including posting information to the site.

In the Help window for the Weblink Manager, it doesn't say what the default length is for the "description" field, which is something that could really help me keep from pulling out the rest of my hair -- or even from going the rest of the way gray a little faster than I'm doing it on my own.

For most links, the default length allowed in Joomla has worked fine, but it seems everyone has independently stumbled upon the field's maximum length and sent me messages about it via email.  I have it on my ToDo list -- that if we opt to stay with Joomla -- to find the coding and nix the limit -- but for others, it might be helpful to say in the Help window that the default length is limited to (#) characters or (#) words.

Hi Scoop0901,

Firstly you are quite right to jump straight in - we don't bite - especially if people want to throw ideas our way.

To be honest I am not aware of this ever having been raised before - but you are right there are situations where this sort of information would be useful.

It is always a trick to balance between too much and too little information on a particular subject but I will certainly look into the possibility of including this information for web links and other appropriate Content Item fields.

Thanks for the suggestion.

Andy

Global Configuration - Server Tab: http://help.joomla.org/content/view/51/153/1/5/

Change: Error Reporting: If this option is enabled under the Site tab then, using the drop down box, select the level of reporting that is required.

Options are:

    * System Default -  This turns Error reporting to the system default according to the php.ini file on the web server.
    * None - This turns error reporting off.
    * Simple -  This turns error reporting to simple options using the following options: error_reporting (E_ERROR|E_WARNING|E_PARSE)as defined in the php.ini file of the web server.
    *  Maximum -  This turns error reporting to the Maximum level using the following options: error_reporting (E_ALL)

To: Error Reporting: Selects the level of PHP error reporting when the Debug Site option is set to Yes in the Site Tab.  See http://www.php.net/error-reporting for further information.

Options are:

    * System Default -  This allows the level of error reporting to be determined by the php.ini file on the web server.
    * None - This turns error reporting off.
    * Simple -  This turns error reporting to E_ERROR | E_WARNING | E_PARSE (see http://www.php.net/error-reporting).
    * Maximum -  This turns error reporting to the maximum level (E_ALL) .


Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Global Configuration: Metadata Tab: http://help.joomla.org/content/view/51/153/1/6/

Change: Show Title Meta Tag: Shows the Title meta tag in the source code when viewing content.
To: Show Title Meta Tag: Includes a "title" meta tag when viewing a content item.

Change: Show Author Meta Tag: Shows the Authors meta tag in the source code when viewing content.
To: Show Author Meta Tag: Includes an "author" meta tag when viewing a content item.

Change: Do some research on Search Engine Optimization if high rankings
To: Do some research on Search Engine Optimisation if high rankings
Reason: British/Australian spelling is preferred.

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Global Configuration - Mail Tab: http://help.joomla.org/content/view/51/68/1/7/

Change: Mailer: Select the mail server that is to be used to send e-mails from the web site.
To: Mailer: Select the method that is to be used to send e-mails from the web site.

Change: Mail From: Enter the e-mail address that appears on all e-mails sent out by the web site.
To: Mail From: Enter the e-mail address that is to appear on all e-mails sent from the web site.

Change: From Name: Enter the name that should appear in the From Field on all e-mails sent out by the web site.
To: From Name: Enter the name that should appear in the From field on all e-mails sent out by the web site.

Change: Sendmail Path: Displays the path to the Sendmail directory on the server.
To: Sendmail Path: Displays the path to the Sendmail program on the server.  This field is only used if the Mailer field is set to Sendmail and your web server is running the Sendmail program.

Change: SMTP Auth: Select Yes if SMTP Authentication is required by the web server host.
To: SMTP Auth: Select Yes if SMTP Authentication is required by your hosting company's mail server.  This field is only used if the Mailer field is set to SMTP Server.

Change: SMTP User: If SMTP Authentication is required by the web server host and set above, enter the Username for the account.
To: SMTP User: If SMTP Authentication is required by your hosting company's mail server, enter the Username for the account.  This field is only used if the Mailer field is set to SMTP Server and the SMTP Auth field is set to Yes.

Change: SMTP Pass: If SMTP Authentication is required by the web server host and set above, enter the Password for the account.
To: SMTP Pass: If SMTP Authentication is required by your hosting company's mail server, enter the Password for the account.  This field is only used if the Mailer field is set to SMTP Server and the SMTP Auth field is set to Yes.

Change: SMTP Host: This is normally set to localhost if the mail server is on the same machine as the web server but it may be necessary to check this detail with the web server host if this is unclear.
To: SMTP Host: This is the name that the web server will give to the mail server to identify itself when sending mail.  This is normally set to localhost if the mail server is on the same machine as the web server but it may be necessary to check this detail with your hosting company if this is unclear.  This field is only used if the Mailer field is set to SMTP Server.

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Thanks Chris!

_________________
Michelle Bisson, POPcliQ, http://www.popcliq.com
Joomla / OSM Trademarks Team Member

Thanks Chris,
Done. Have added comments with regard to location of reports within Joomla! and accessibility by all.

Andy

Done Thanks

Andy

Done with some changes to word order.

Thanks for your continuing efforts Chris.

Andy

Global Configuration: Cache Tab: http://help.joomla.org/content/view/51/153/1/8/ - No problems found.

Global Configuration: Statistics Tab: http://help.joomla.org/content/view/51/153/1/9/

Change: If the web site experiences a slight delay whenever a first time a User visits the site you should set this to No.
To: If the web site experiences a slight delay whenever a User visits the site for the first time, you should set this to No.

Change: Log Content Hits by Date: Select Yes to enable logging of the hits on Content Items, on a daily basis. There are currently no in-built analysis routines, to complement this logging feature. Select No to disable this feature.
To: Log Content Hits by Date: Select Yes to enable logging of the hits on Content Items on a daily basis. There are currently no in-built analysis routines to complement this logging feature. Select No to disable this feature.
i.e. remove extraneous commas.

Change: It may also prove an invaluable source in identifying potential weak areas in the web site content
To: It may also prove an invaluable resource in identifying potential weak areas in the web site content

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Thanks Chris



Done.

Added with some modification.

Done



Andy

Global Configuration: SEO Tab: http://help.joomla.org/content/view/51/153/1/10/

Suggest moving the "Related Information" section to the first page of Global Configuration, i.e. here: http://help.joomla.org/content/view/51/153/


Language Manager: http://help.joomla.org/content/view/52/222/

Change: This Language Manager displays a list of the Languages available for the core text on the Front-end of the Joomla! web site and their current status.
To: The Language Manager displays a list of the Languages available for the Front-end of the Joomla! web site.  These Languages apply to the Joomla! core only and may not affect any Components, Modules or Mambots that may be in use.  A Language is only available to Users if it is published.

For consistency, Language should be capitalised (except in "language file"?):
Change: Publish:  To Publish a language, select the radio button next to the name of the language and click the Publish icon.
To: Publish:  To publish a Language, select the radio button next to the name of the Language and click the Publish icon.

Change: New: Click the New icon to upload and install a new language to the Language Manager.
To: New: Click the New icon to upload and install a new Language to the Language Manager.

Change: Edit: Click the name of the language, or select the radio button next to the name, and click the Edit icon. This opens the selected language file in the Language Editor where it is possible to edit the phrases and the wording of particular screen labels, references, and messages of the selected language.
To: Edit: Click the name of the Language, or select the radio button next to the name, and click the Edit icon. This opens the selected language file in the Language Editor where it is possible to edit the phrases and the wording of particular screen labels, references, and messages of the selected Language.

Change: Delete: To delete a language, select the radio button next to the name....
To: Delete: To delete a Language, select the radio button next to the name....

Change: Language: This column shows the name of the languages installed on this web site.
To: Language: This column shows the names of the Languages installed on this web site.

Change: Published: This column shows the active language(s) that is published.
To: Published: This column shows which of the installed Languages are published.

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

yep I struggled with this one: I have three versions in mind of what is the right approach:
Consistency - I attached the Related Information as the last item on all screens - which almost acts as a terminator - and didn't want people to think that it was the end of th screen if they came across it in this first page.
Option - Add it to the end of each page as the information may be relevant to that page...
Option - Add a link to each page

Poss Solution - literally just come to me - Add it as a separate page at end of doc that way it appears on all pages - problem solved - I think.



All done. Thanks Chris

Andy

Hey Chris,

If there are multiple occurrences of the same issue in a page such as (l)Language in your last post I am quite happy if you just say change all or check all for example and I will do a word find/replace.

Just trying to make it less hassle.

thanks

Andy

Thanks Andy, I'll do that in future.

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org

Just noticed another one on Language Manager: http://help.joomla.org/content/view/52/153/

Right at the top:
Change: Type: com_Languages
To: Type: com_languages


Language Editor: http://help.joomla.org/content/view/1696/153/

Change: Type: to be confirmed
To: com_languages

Remove extraneous comma in:
Save: Click the Save icon to permanently apply the changes, made during the current editing session.

Change: Both these actions will return the administrator to the Language Manager.
To: Both these actions will return you to the Language Manager.

Regards,
Chris.

_________________
Joomla Leadership Team - Production Working Group

Joomla Web Services http://www.kickstarter.com/projects/964120480/joomla-web-services
Lion Coppice http://www.lioncoppice.org