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: Random Image
http://help.joomla.org/content/view/1535/196/

Thanks rdb!

*** Checked back in ***

The Random Image module displays a randomly selected image from a designated folder/directory.
The Random Image module displays a randomly selected image from a set of images located in a designated folder or directory on the website.

Type: mod_random_image

Details:

Title: Title of the module to display on the page.
Title: Enter or edit (if needed) the title that will be displayed in the title bar of the module on the displayed page.

Show title: Decides if the Title will display or not on the page.
Show title: Select "Yes" to have the title displayed. Select "No" to hide the title.

Position: Sets which of the positions available the module will display in.
Position: Click this dropdown menu to place this module in a specific position on the displayed page. For example selecting "left" position places the module in the displayed page's left column. Selecting "right" position places the module in the displayed page's right column. These positions are determined by the location of these positions in the template.

Module order: The order the module will appear among modules assigned to the same page, in the same position.
Module order: Click an element in this drop down menu to determine the order this module will appear relative to other modules listed in the same "Position" (e.g. "left" or "right"). See "Position" in this document.

Access Level: Sets who can view this module. Public, Registered or Special.
Access Level: Click the elements of this menu (the site’s user groups) to determine which sets of users have access to this module.

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 "Yes" to publish this module; click "No" to unpublish. Published modules are displayed on the pages selected in the "Pages / Items " menu on this page. Unpublished modules are hidden from view, even if there are selections made in "Pages/Items".

ID: This is the ID number for the module item. This is auto-allocated by the Joomla system when the module is saved.
ID: This is a unique identification number assigned to this module by the Joomla! system. This is automatically generated and cannot be changed.

Pages / Items: Sets on which pages the module should be displayed.
Pages / Items: Click one or more items in this menu to determine the pages this module will be displayed on. Where the module is actually displayed is affected by the choices made in the "Position" menu mentioned on this page.

Parameters:

Module Class Suffix: 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.

Image Type: Type of image (jpg, png, gif, etc.). Default is jpg.
Image Type: Enter the image type of the files to be randomly displayed, e.g. jpg, png, gif, etc. The default image type is jpg.

Image folder: Path to the images folder relative to the site url (eg. images/stories)
Image Folder: Enter the path of the folder/directory containing the images to be randomly displayed. Enter the location of this folder/directory relative to the top level of the website.  (e.g. If the files are located in http://www.joomla.org/images/random then enter "images/random" in the text box.) Finally, the folder/directory must already exist, as this module does not create it for you.


Link: URL to redirect to if image is clicked on (eg. http://www.joomla.org)
Link: Enter the URL that a user will be redirected to if the image is clicked (eg. http://www.joomla.org).


Width (px): Image's width in pixels. This forces all images to be displayed with this width. This may cause unwanted results if the original image has a different width.
Width: Enter the width in pixels you want the images displayed. This will force all images to be displayed using this fixed width. Note: This may cause unwanted results if there is a sizeable difference between this number and the width of the original image (especially if the height of the image is not comparably adjusted).

Height (px): Image's height in pixels. This forces all images to be displayed with this height. This may cause unwanted results if the original image has a different height.
Height: Enter the height in pixels you want the images displayed. This will force all images to be displayed using this fixed height. Note: This may cause unwanted results if there is a sizeable difference between this number and the height of the original image (especially if the width of the image is not comparably adjusted)

Module Class Suffix: Enter the suffix for the CSS class of this module. (e.g .moduletable-poll). In this example, the "-poll" is the suffix. This suffix class must currently be in the template CSS Style file.  This allows individual CSS classes to be applied to certain modules independent of the site's default Template CSS classes.

no problema

*** Checked back in *** Suggested modifications

The Random Image module displays a randomly selected image from a designated folder/directory.
The Random Image module displays a randomly selected image from a set of images located in a designated folder or directory on the website.

Type: mod_random_image

Details:

Title: Title of the module to display on the page.
Title: Enter or edit (if needed) the title that will be displayed in the title bar of the module on the displayed page.

Show title: Decides if the Title will display or not on the page.
Show title: Select "Yes" to have the title displayed. Select "No" to hide the title.

Position: Sets which of the positions available the module will display in.
Position: Click this dropdown menu to place this module in a specific position on the displayed page. For example selecting "left" position places the module in the displayed page's left column. Selecting "right" position places the module in the displayed page's right column. These positions are determined by the location of these positions in the template.
Position: Select the position from this dropdown select box to place this module in a specific position on the displayed page. For example selecting "left" position places the module in the displayed page's left column. Selecting "right" position places the module in the displayed page's right column. These positions are determined by it's location in the template.

Module order: The order the module will appear among modules assigned to the same page, in the same position.
Module order: Click an element in this drop down menu to determine the order this module will appear relative to other modules listed in the same "Position" (e.g. "left" or "right"). See "Position" in this document.
Module order: Select the order this drop down select box to determine the order this module will appear relative to other modules listed in the same "Position" (e.g. "left" or "right"). See "Position" in this document.

Access Level: Sets who can view this module. Public, Registered or Special.
Access Level: Click the elements of this menu (the site’s user groups) to determine which sets of users have access to this module.
Access Level: Select the access level (which is the site’s user groups) from the select box to determine which sets of users have access to this module.

Published: Sets if the module contents will show on the Frontend of your Web site (if chosen Position is available in the template).
Published: Select "Yes" to publish this module; Select "No" to unpublish. Published modules are displayed on the pages selected in the "Pages / Items " menu on this page. Unpublished modules are hidden from view, even if there are selections made in "Pages/Items".

ID: This is the ID number for the module item. This is auto-allocated by the Joomla system when the module is saved.
ID: This is a unique identification number assigned to this module by the Joomla! system. This is automatically generated and cannot be changed.

Pages / Items: Sets on which pages the module should be displayed.
Pages / Items: Click one or more items in this menu to determine the pages this module will be displayed on. Where the module is actually displayed is affected by the choices made in the "Position" menu mentioned on this page.
Pages / Items: Select one or more items in this select box to determine the pages this module will be displayed on. The positions that the module is actually displayed is affected by the choices made in the "Position" menu mentioned on this page.

Parameters:

Module Class Suffix: 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.

Image Type: Type of image (jpg, png, gif, etc.). Default is jpg.
Image Type: Enter the image type of the files to be randomly displayed, e.g. jpg, png, gif, etc. The default image type is jpg.

Image folder: Path to the images folder relative to the site url (eg. images/stories)
Image Folder: Enter the path of the folder/directory containing the images to be randomly displayed. Enter the location of this folder/directory relative to the top level of the website.  (e.g. If the files are located in http://www.joomla.org/images/random then enter "images/random" in the text box.) Finally, the folder/directory must already exist, as this module does not create it for you.
Image Folder: Enter the path of the folder/directory (relative to the top directory of the web site) containing the images to be randomly displayed.  For example, if the files are located in http://www.joomla.org/images/random then enter "images/random" in the text box.) Finally, the folder/directory must already exist, as this module does not create it for you. As well, there needs to be at least one image in the directory.

Link: URL to redirect to if image is clicked on (eg. http://www.joomla.org)
Link: Enter the URL that a user will be redirected to if the image is clicked (eg. http://www.joomla.org).


Width (px): Image's width in pixels. This forces all images to be displayed with this width. This may cause unwanted results if the original image has a different width.
Width: Enter the width in pixels you want the images displayed. This will force all images to be displayed using this fixed width. Note: This may cause unwanted results if there is a sizeable difference between this number and the width of the original image (especially if the height of the image is not comparably adjusted).
Width: Enter the width in pixels you want the images displayed. This will force all images to be displayed using this fixed width.

Note: This may cause unwanted results if there is a sizeable difference between this number and the width of the original image (especially if the height of the image is not comparably adjusted).


Height (px): Image's height in pixels. This forces all images to be displayed with this height. This may cause unwanted results if the original image has a different height.
Height: Enter the height in pixels you want the images displayed. This will force all images to be displayed using this fixed height. Note: This may cause unwanted results if there is a sizeable difference between this number and the height of the original image (especially if the width of the image is not comparably adjusted)
Height: Enter the height in pixels you want the images displayed. This will force all images to be displayed using this fixed height.

Note: This may cause unwanted results if there is a sizeable difference between this number and the height of the original image (especially if the width of the image is not comparably adjusted)


Module Class Suffix: Enter the suffix for the CSS class of this module. (e.g .moduletable-poll). In this example, the "-poll" is the suffix. This suffix class must currently be in the template CSS Style file.  This allows individual CSS classes to be applied to certain modules independent of the site's default Template CSS classes.

rdb,

Take another look at my revision.  I believe that it is a bit clearer.  I was looking at some of the terminology, such as drop down menu box and I realized that calling it a drop down select box was a better name.  As well, I changed some of the verbs from 'click' to 'select'. 


If you see something that I missed or incorrectly modified, please post your suggestions here!

Thanks!!!

Actually, I have never heard of a drop down select box and was wondering what it was when I first saw it.  I have always heard "drop-down menu," so it is ok, we all were kind of confused...lol 

Hey Guys, I think we just need to standardize on terminology used, but once we do things should start moving along a bit faster.

The text in the "Details" section was text I cut and pasted from the "Who's online module" submission that was approved the day before. I think we should settle on the "Details" text as from module to module it's basically the same.
(Only the parameters section changes). Which introduces another wrinkle, if we change the "Details" section here do we have to now go back and make it the same in previously accepted submissions?

As far as "Select box" vs "Menu" it may be a toss up. The HTML spec defines this element as a but if you read the spec it says "The SELECT element creates a menu. Each choice offered by the menu is represented by an OPTION element. A SELECT element must contain at least one OPTION element." (http://www.w3.org/TR/html401/interact/forms.html#h-17.6.)

Thinking about it now "menu" might make more sense to the average user. Technical users should recognize that MENU and SELECT are the same.

So Michelle I might have to disagree with both of us and suggest that we standardize on MENU. What do you guys think ?


-- richard
_________________
-- Joomla! Evangelist

Good review RDB.  Michelle and I are both working on standarizing things.  And I am working on changing things in the past submissions to make them legit with the ones that we comment on now.  It is a back and forth process. 

By the way, when we are refering to a drop-down selection from this point forward, we are going to call it a 'drop-down list.'  When there is a drop-down that has menus leading you from the page that you are on, then it will be a drop-down menu (the hyphen included).  There are also boxes that are not drop down but allow you to select items, such as when you can select which menu items (webpages) that you want your modules to appear on, those are called 'multi-item select box.'  So there is a lot of 'standarizing' to do.

Michelle has stated that the "next future phase after this initial proof-reading phase is to harmonize the style throughout."  So we will be going back through. 

We do appreciate all the proof-reading and once Michelle has trained the proof-reading teams for the help screens (I am one of those) we will be able to train those of you that are volunteering and probably be able to implement more of a standarized system.  That is why Michelle is proofreading after everyone else has already done so. 

So keep doing what you are doing and just refer back to the already "revised" threads to get an idea of what should be written.  It all helps and if 20 people proof-read a doc and use the same terminology doing so on certain things, than obviously that will become the standard, because what we want most is for everyone to be able to understand the help docs.

Thanks rdb,
Charles

Charles, thanks for the comments.

This is what I'll do. I'll go through this module once more, apply Michelle's edits and replace the references to menus, selects, etc with the definitions you've suggested.

Once this is done then I think we can "freeze"  the "Details"  text and cut and paste from module to module. This way we only have to focus on the features that are unique to the module being edited. (parameters, etc)

We should also point other reviewers to the standardized "Details" text so we're not reinventing the wheel each time.

-- richard

That is a good idea rdb.  Though some sections will be different depending on the parameters, but I know that most of the details sections are pretty much the same.  I will point Michelle to this thread and suggest that to her.  If you are going to do another revision just let me know by checking this thread out again.  I will wait to add this to the help site until you are done. 

Thanks.

** Checked back in **

Michelle's edits, "drop-down list" and "multi item select box" mods applied.

The Random Image module displays a randomly selected image from a designated folder/directory.
The Random Image module displays a randomly selected image from a set of images located in a designated folder or directory on the website.

Type: mod_random_image

Details:

Title: Title of the module to display on the page.
Title: Enter or edit (if needed) the title that will be displayed in the title bar of the module on the displayed page.

Show title: Decides if the Title will display or not on the page.
Show title: Select "Yes" to have the title displayed. Select "No" to hide the title.

Position: Select the position from this dropdown select box to place this module in a specific position on the displayed page. For example selecting "left" position places the module in the displayed page's left column. Selecting "right" position places the module in the displayed page's right column. These positions are determined by it's location in the template.
Position: Select the position from this drop-down list to place this module in a specific position on the displayed page. For example selecting "left" position places the module in the displayed page's left column. Selecting "right" position places the module in the displayed page's right column. These positions are determined by it's location in the template.

Module order: Select the order this drop down select box to determine the order this module will appear relative to other modules listed in the same "Position" (e.g. "left" or "right"). See "Position" in this document.
Module order: Select the order from this drop-down list to determine the order this module will appear relative to other modules listed in the same "Position" (e.g. "left" or "right"). See "Position" in this document.

Access Level: Select the access level (which is the site’s user groups) from the select box to determine which sets of users have access to this module.
Access Level: Select the access level (which is the site’s user groups) from the multi-item select box to determine which sets of users have access to this module.

Published: Sets if the module contents will show on the Frontend of your Web site (if chosen Position is available in the template).
Published: Select "Yes" to publish this module; Select "No" to unpublish. Published modules are displayed on the pages selected in the "Pages / Items " menu on this page. Unpublished modules are hidden from view, even if there are selections made in "Pages/Items".

ID: This is the ID number for the module item. This is auto-allocated by the Joomla system when the module is saved.
ID: This is a unique identification number assigned to this module by the Joomla! system. This is automatically generated and cannot be changed.

Pages / Items: Select one or more items in this select box to determine the pages this module will be displayed on. The positions that the module is actually displayed is affected by the choices made in the "Position" menu mentioned on this page.
Pages / Items: Select one or more items in this multi-item select box to determine the pages this module will be displayed on. The positions that the module is actually displayed is affected by the choices made in the "Position" menu mentioned on this page.

Parameters:

Image Type: Type of image (jpg, png, gif, etc.). Default is jpg.
Image Type: Enter the image type of the files to be randomly displayed, e.g. jpg, png, gif, etc. The default image type is jpg.

Image Folder: Enter the path of the folder/directory containing the images to be randomly displayed. Enter the location of this folder/directory relative to the top level of the website.  (e.g. If the files are located in http://www.joomla.org/images/random then enter "images/random" in the text box.) Finally, the folder/directory must already exist, as this module does not create it for you.
Image Folder: Enter the path of the folder/directory (relative to the top directory of the web site) containing the images to be randomly displayed.  For example, if the files are located in http://www.joomla.org/images/random then enter "images/random" in the text box.) Finally, the folder/directory must already exist, as this module does not create it for you. As well, there needs to be at least one image in the directory.

Link: URL to redirect to if image is clicked on (eg. http://www.joomla.org)
Link: Enter the URL that a user will be redirected to if the image is clicked (eg. http://www.joomla.org).


Width: Enter the width in pixels you want the images displayed. This will force all images to be displayed using this fixed width. Note: This may cause unwanted results if there is a sizeable difference between this number and the width of the original image (especially if the height of the image is not comparably adjusted).

Width: Enter the width in pixels you want the images displayed. This will force all images to be displayed using this fixed width.

Note: This may cause unwanted results if there is a sizeable difference between this number and the width of the original image (especially if the height of the image is not comparably adjusted).


Height: Enter the height in pixels you want the images displayed. This will force all images to be displayed using this fixed height. Note: This may cause unwanted results if there is a sizeable difference between this number and the height of the original image (especially if the width of the image is not comparably adjusted)

Height: Enter the height in pixels you want the images displayed. This will force all images to be displayed using this fixed height.

Note: This may cause unwanted results if there is a sizeable difference between this number and the height of the original image (especially if the width of the image is not comparably adjusted)


Module Class Suffix: Enter the suffix for the CSS class of this module. (e.g .moduletable-poll). In this example, the "-poll" is the suffix. This suffix class must currently be in the template CSS Style file.  This allows individual CSS classes to be applied to certain modules independent of the site's default Template CSS classes.

Thanks Rdb!  I'll take a look at this tomorrow evening!

Rdb,

This text is ready to be transfered to the help site.  Would you mind doing that?  Then please update the changelog for 1.0x
http://help.joomla.org/content/view/704/105/

Let me know when you have done this in this thread.

Thanks!

Hi Michelle,

I still don't have a login to the help site. I sent a PM to manuman about a week ago but haven't heard anything.
Can you give me access ?

I am sending you a pm.

Hi, did this get transfered?  If not, let me know and I can transfer it if rdb is still having problems with the login.

Charles

rdb,

Go ahead and transfer this information to the Help Site.  Please update the changelog here as well.

http://help.joomla.org/content/view/704/105/

Just let me know when this has been completed

Thanks!

Michelle information transferred, change log updated

rdb,

As well, would you update : Module: Random Image 1.1x  and update the change log for 1.1x? 
Note: I have renamed this thread.

Thanks!

Hi,

I just wanted to see if this was completed before the thread gets buried.

Thanks Charles, for keeping an eye on any buried threads!!!

Michelle,

I did check today and this doc has been updated in 1.1x docs on the 9th, along with the changelog.  You can wait for rdb to verify, but it has indeed 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.