Joomla! Discussion Forums

Please edit and proof-read this text. I will then update the admin manual.  Please read: Guidelines for Editing and Proof-reading:

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

Please publish your work here in this thread.

Thanks!
============================================
Module: Login Form
http://help.joomla.org/content/view/1481/196/

Michelle, since I am not technically proficient like most on here and since this is the first time I've tried to participate in editing, I didn't want to officially 'check out', however, I did want to take a pass at something.  My changes in green. Typos in red.  I'd like a green light to continue or not.  Thanks.

(Note to editor:  In 1.0.2, 'Enable Cache' does not appear under Parameters as written below.)


Module: Login Form    PDF    Print    E-mail

-- Draft Version

The Login Form module displays a Username and Password login form. It also displays a link to retrieve a forgotten password. If user registration is enabled, (refer to the Global Configuration settings), then another link will be shown to invite users to self-register. If the user is logged in, the module displays a "Logout" link.

Type: mod_login

Details:

Title: Title of the module to display on the page.
Title: This is the text box where you will enter the Title which will be displayed on the page.

Show title: Sets if the Title will display or not on the page.
Show title: Click a radio button to determine whether or not the Title will display on the page.

Position: Sets which of the positions available the module will display in.
Position: Select from a drop down menu which of the positions available the module will display in on the page.

Module order: The order the module will appear among modules assigned to the same page, in the same position.
Module order: Select from a drop down menu the order the module will appear among modules assigned to the same page, in the same position.

Acces Level: Sets who can view this module. Public, Registered or Special.
Access Level: Click to set who can view this module - Public, Registered or Special.

Published: Sets if the module contents will show on the Frontend of your Web site (if chosen Position is available in the template).
Published: Click on a radio button to set whether or not the module contents will show on the Frontend of your Web site (if chosen Position is available in the template).

ID: This is the ID number for the module item. This is auto-allocated by the Joomla system when the module is saved. 

Pages / Items:
Sets on which pages the module should be displayed.
Pages / Items: From the drop down menu, set which pages the module should be displayed in.

Parameters:

Module Class Suffix: A suffix to be applied to the CSS class of the module (table.moduletable) to allow individual module styling.
Module Class Suffix: A text box where you may enter a suffix to be applied to the CSS class of the module (table.moduletable) to allow individual module styling.

Enable Cache: Select to cache or not the content of this module.
Enable Cache: Select to cache or not the content of this module.

Pre-text: This allows to display text or HTML above the login form.
Pre-text: Use this text box to display text or HTML above the login form.

Post-text: This allows to display text or HTML below the login form.
Post-text: Use this text box to display text or HTML below the login form.

Login Redirection URL:You may enter here the URL of a page you want the logout to redirect to. If left blank, it will load the Home Page.
Login Redirection URL: Use this text box to enter the URL of a page you want the login to redirect to. If left blank, it will load on the Home Page.

Logout Redirection URL: You may enter here the URL of a page you want the logout to redirect to. If left blank, it will load the Home Page.
Logout Redirection URL:  Use this text box to enter the URL of a page you want the logout to redirect to. If left blank, it will load on the Home Page.

Login Message: Show/Hide the javascript Alert indicating Login success or failure.
Login Message: Click the radio button to Show/Hide the Javascript Alert indicating Login success or failure.

Logout Message: Show/Hide the javascript Alert indicating Logout success.
Logout Message: Click the radio button to Show/Hide the Javascript Alert indicating Logout success.

Greeting: Show/Hide the simple greeting text.
Greeting: Click on the radio button to Show/Hide the simple greeting text.

Name/Username: Choose here to display one or the other in the greeting. The Name is defined for each registered user in the list accessed through Site -> User Manager -> Add/Edit users under the heading Name, the Username in the same list under the heading UserID.
Name/Username: From the drop down menu, choose here to display one or the other in the greeting. The Name is defined for each registered user in the list accessed through Site -> User Manager -> Add/Edit users under the heading Name, the Username in the same list under the heading UserID.

t17169,

Overall, you seem to do a good job and have understood what I wanted to have done.  I have corrected a few items.  Please feel free to continue editing and proof-reading.
============================

Title: Title of the module to display on the page.
Title: Enter or edit the 'Title' in the text box that will be displayed on the page on your Web site.

Pages / Items: Sets on which pages the module should be displayed.
Pages / Items: From the drop down menu, select which pages the module should be displayed on.

Module Class Suffix: A suffix to be applied to the CSS class of the module (table.moduletable) to allow individual module styling.
Module Class Suffix: Enter or edit the suffix of the CSS class of the module (table.moduletable) in this text box.  This allows individual module styling.

Enable Cache: Select to cache or not the content of this module.
Enable Cache: Select to cache or not the content of this module.

Pre-text: This allows to display text or HTML above the login form.
Pre-text: Type (if needed) in this text box the display text or HTML that will appear above the login form.

Post-text: This allows to display text or HTML below the login form.
Post-text: Type (if needed) in this text box the display text or HTML that will appear below the login form.

Login Redirection URL:You may enter here the URL of a page you want the logout to redirect to. If left blank, it will load the Home Page.
Login Redirection URL: Enter the URL of a page in this text box that you want the login to redirect to. If left blank, it will load on the Home Page.


Name/Username: Choose here to display one or the other in the greeting. The Name is defined for each registered user in the list accessed through Site -> User Manager -> Add/Edit users under the heading Name, the Username in the same list under the heading UserID.

Name/Username: From the drop down menu, choose here to display either the name or the username in the greeting. The Name is defined for each registered user in the list accessed through Site -> User Manager -> Add/Edit users, under the heading Name, the Username in the same list under the heading UserID.

This last sentence is in orange because I feel that it still needs to be rewritten as I find it not clear.  I am open to suggestions.

If anyone see other corrections that need to be made, please post them here. 

Thanks!

Charles,
This text is basically ready to transfer to the help site.

Of course, if others still find some needed spelling/grammar errors, please post the corrections here. 

Michelle,

Revisions for the Module: Login Form 1.0x has been moved to the help site and the changelog has been updated.

For the sentence in orange posted below, I wrote:

The name is defined for each registered user in the list, accessed through Site -> User Manager -> Add/Edit Users, under the heading 'Name,' and the username in the same list under the heading 'UserID.'

Charles

Charles,

I think that this sentence can be rewritten as two sentences.  It might make it clearer.

What do you think?  If you are in agreement, please write it into two sentences and publish it here and I will then review it.

How about...

"The name is defined for each registered user in the list and can be accessed through Site -> User Manager -> Add/Edit users.  The name given by the user will be displayed under the heading "Name," and the username will be displayed in the same list under the heading "UserID."

Just a stab...

Charles,

This sounds better.  Can you update the help site with this modification as well as the changelog fille?  Just let me know when you have done this then this help screen is ready for someone (fresh eyes) to go through another revison just in case we missed something.

Thanks!

Thank you Charlles!

Michelle,

Checked In. Revisions for the Module: Login Form 1.0x has been moved to the help site and the changelog has been updated.  I have also updated the link to this forum.

For all volunteers:

This content item is ready for another revision, or proof-reading, by someone who has not already proof-read it.

Fresh eyes for proof-reading might discover something that was missed in the first revisions.

Thank you!

Charles

Thanks Charles!

Hi Michelle,

Did this doc just get converted to the 1.1x section of the help site?

Let me know.  If not, then I will update it. 

Charles,

Can you verify this?

Yes, I verified and they all look identical to me.  They must of been updated.

Thanks  Charles!



This can be done by anyone in the community who wishes to proof-read occasionally without committing to the doc project on an on going manner.