User manual

User view of My Galleries

Link to "My Galleries"

(1) Select menu where galleries are displayed in web site

Attention: The menu name may different and may appear in a horizontal menu inside sub menus

(2) Login with your user name given by owner of website The system needs you to be logged in. Otherwise the "My Gallery" rights can't be assigned to a user

(3) Click on "My Gallery" link This will lead you to the "My Gallery" page where your galleries can be created, images uploaded and edited. This view enables to just see the "owned" galleries and images

First My Galleries user view

(1) Create gallery tab

This is where the fun begins ....

If this tab does not appear the user has not enough rights

Create a gallery

My Gallery: create gallery

On the My Galleries page click the Create Gallery tab. This tab only shows when the user that is logged in has Create permission.

(1) Select parent gallery To create a new gallery, first choose its parent. Choose "Top gallery" when you want the gallery to have no parent.

(2) Assign a name

(3) Fill out a description (May be empty)

(4) Save (create) gallery with entered settings

Click the little disk button at the top right of the "Create Gallery tab" to save the settings

(5) Cancel creation Click the red round button with a white cross inside to clear all fields.

Saving the gallery details returns you to this page and this tab, but with the extra gallery created (note: this gallery is unpublished by default). Unless of course the user already is at its maximum allowed galleries, then the gallery will not be created.

My Gallery: create gallery done View after first gallery is created

Attention "Add image" is now available

Galleries overview

My Gallery: Galleries overview

(1) Gallery name clicking on the name will lead to the editing page of the gallery

(2) Publish/unpublish gallery

Change the state of a gallery: published or unpublished red/green

In the Published column the user can tell by the icon if the gallery is published (green icon with white check mark) or unpublished (red icon with white dot inside). When the user is not allowed to change the state, the icons are grey, but with either the check mark or the dot. A click on the icon toggles the state from unpublished to published and vice versa.

(3) Delete gallery A gallery can be deleted by clicking on the Delete icon. You will be asked to confirm the deletion of the gallery.

Attention: Images still in the gallery will be deleted as well

(4) Edit gallery

The details like the name and description of the gallery can be edited and a different parent gallery can be chosen. The gallery can be edited by either clicking on the gallery name or on its Edit icon

Doing this shows a new window with the gallery details

Image Upload

My Gallery: Image upload On the My Galleries page click the Add Image tab. This tab only shows when the user that is logged in has "Create permission" for one or more galleries.

(1) Select parent gallery

To add your image(s), first choose the gallery that will hold the image(s).

(2) Select a file on your PC / device

You can either add a single image, or a set of images in a zip file. Browse to the file to select it.

There is a restriction of the size of a zip that can be uploaded. It depends on the settings of the server that hosts the web page.

(3) Assign a title

(4) Fill out a description (May be empty)

In case of multiple images in a zip file, this title and description will be used for each image.

(5) Upload gallery with entered settings

To upload your image(s) and save the details, click the disk button at the top right of the Create Gallery tab.

(6) Cancel upload

Next to the disk button is a red round button with a white cross inside. Use this cancel button to clear all fields.

Saving the item returns you to this page and this tab, but with the extra image(s) created

Note: the newly uploaded image will be unpublished by default). Unless of course the user already is at its maximum allowed item, then the items will not be created.

Images overview

My Gallery: Images overview

(1) Check box for selecting multiple images for batch assignment

(2) Title of images

(3) Gallery

Name of the gallery the image belongs to

(4) Publish/unpublish image

Change the state of a image: published or unpublished red/green

In the Published column the user can tell by the icon if the image is published (green icon with white check mark) or unpublished (red icon with white dot inside). When the user is not allowed to change the state, the icons are grey, but with either the check mark or the dot. A click on the icon toggles the state from unpublished to published and vice versa.

(5) Delete image

A image can be deleted by clicking on the Delete icon. You will be asked to confirm the deletion of the image.

(6) Edit image

The details like the title and description of the image can be edited and a different gallery to which the item belongs to can be chosen. The item can be edited by clicking on its Edit icon. Doing this shows a new window with the item details

(7) Batch publish images

The selected images can be published in one go

(8) Batch unpublish images

The selected images can be unpublished in one go

(9) Batch delete images

The selected images can be changed in one go

Edit image

My Gallery: Edit image The properties to be changed are the same like when uploading the image

(1) The uploaded image is displayed in "edit" view

(2) Click on disk button to save the changes

You can save your changes by clicking the disk icon on the top right

(3) Click on the "red cross" button to cancel and reset the changes

You can cancel your changes by clicking the red round icon with the with the cross inside.

Both save and cancel will take you back to the My Galleries page.

Edit gallery

My Gallery: Edit image The properties to be changed are the same like when creating the gallery

(1) Click on disk button to save the changes

You can save your changes by clicking the disk icon on the top right

(2) Click on the "red cross" button to cancel and reset the changes

You can cancel your changes by clicking the red round icon with the with the cross inside.

Both save and cancel will take you back to the My Galleries page.

My Gallery user information

My Gallery: user information

At the top of the page "My Gallery" there is a box with User information: The name of the user who is currently logged in, the number of galleries this user has already created and its allowed maximum (setting Maximum number of galleries a user can have) and the number of items for which the user is the owner and its allowed maximum (setting maximal numbers of pictures a user can have).

My Gallery appearing on main view

My Gallery: external standard view

If the gallery and at least one image is "published" the it appears on the main page below the "My galleries" link and "Search box"

(1) Information buttons

The icons will indicate * (O) User is the owner of the gallery * (U) User can upload in this gallery * (H) The gallery is hidden and not Published

If the mygallery user hovers over the buttons a explaining text will appear as tool tip


My Gallery: Set it up, get it started

  1. Enable "My Galleries" in RSG2 configuration
  2. Create a user group with rights to handle their own galleries and Images
  3. Assign user rights for this group on
  4. Assign the standard RSGallery2 view to a menu

Configuration of My Galleries

My Galleries configuration

More description in section configuration

Create a user group for "My Galleries" users

My Galleries New user group

A separate user groups helps to assign special rights for "My Gallery" users.

Assign user rights for this "My Galleries" users group

My Galleries configuration

(1) Search for RSGallery2 in System->Global configuration

(2) Select Permissions

(3)-(6) Activate the "Create own", "Delete own", "Edit own", "Edit state own" permissions. The "vote" or "comment" permissions enable actions on the images itself. They are not needed for the handling of galleries and images.

Edit Permission, Edit State Permission (to publish or unpublish an item or gallery), Delete Permission and Create Permission for items and galleries.

A user with none of these permissions can only see the items and galleries, but cannot publish, delete, edit or create items or galleries. That is reflected on the tabs My Images and My galleries by the grey icons for the items and galleries. That user will also not see the Add Image and Create Gallery tabs.

However, when a user has all permissions, the icons are no longer greyed out, and there are two more tabs: Add Image and Create Gallery. A site administrator can choose to give only specific permissions to a user group, e.g. only Edit permission, and only give that permission for a specific gallery. Then the user will see from the icons being grey (and non-functional) or not if they have that permission.

Assign the standard RSGallery2 view to a menu

This may be done already as it is as simple as assigning the standard view to a menu


PDF documentation

This Documentation is written for RSGallery2 version on Joomla! 3.x.

It covers the main parts but is sadly not complete

The content is build on the texts you may find on RSGallery2.org documentation pages


RSGallery2_documentation_J3.x.pdf

PDF documentation

This Documentation was written at the time of Joomla! 2.5.

The screenshots are therefore old, however,things work still quite the same

Checkout the one written for Joomla! 3.x with texts you may find on RSGallery2.org

As you may see above we are working on improvement (part after part)


RSGallery2_documentation_J2.5.pdf

Maintenance functions

The maintenance form supports with sub forms several functions to check and repair the rsgallery2 image and database universe.

Each grey array is a button to click on. In most cases a sub form will open where more info or actions are provided


Base top

Base bottom

Zones

  • Rsgallery2 zone

    Handles slideshows and templates

  • Repair zone

    The image file system can be checked to match the database. Also the configuration can be checked here.

  • Danger zone

    Delete database entries and database structure

  • Raw database zone

    A window to the pure content of the database (lists)

  • Outdated zone

    Door to old view of functions like image/galleries lists

  • Upgrade (from 1.x / 2.x) zone

    Helpers after upgrading RSG2 from previous J!x versions

Rsgallery2 zone

zone.RSGallery2

(1) Slideshow configuration

Edit and check the configuration parameters of installed slideshows. Leads to a separate view for the edit of slideshow parameter.
See separate maintenance document ""

(2) Comments list

Enters list view of comments

(3) Template manager

Actually not working. (2014-2018)
In older version it had the function to upload slideshows and templates for the display of the gallery in frontend. These could be edited or deleted also.

Repair zone

zone.repair.png

(1) Consolidate image database

The consistence of the database to image files can be checked here. The following view supports the check and repair of image orphans in database or as missing image files.


(See separate maintenance document "")

(2) Configuration Raw edit

Edit view of all config variables including internal settings. Prepared for debug and emergency situations. Lists all variables in alphabetical order. The values can be changed and saved.

(4) Regenerate display images

This option will regenerate either thumbnail or display images, based on the current configuration settings of thumbnail dimensions

(5) Optimize database

Reorganizes the physical storage of the database table data to reduce storage space and improve speed when accessing the table

Danger zone

maintenance.zone.danger.png

(1) Purge tables (data) & delete all images

Supports the first step to remove RSGgallery2 completely.

Therefore the content (items) in all RSGaller2 tables are removed. Additionally the image files are deleted. The data structure is kept but is empty.

This can also be used to purge the data and start again empty with new images and new galleries.

If afterwards the component is de installed nothing shall be left and remind of RSGallery2

(2) Remove RSGallery2 tables and images The previous intention was to support the uninstall that by removing databases tables and image files. The side effect of this function was that Joomla! did start with error and RSGallery2 could not be uninstalled

Instead of using this function begin with above function 'Purge tables (data)' See following instruction for a complete remove

How to remove RSGALLERY2 completely

(1) Use Maintenance -> Purge tables

This removes the database content and the image files

(2) Prepare the remove of database table structure

Search in admin rsgallery2 folder \administrator\components\com_rsgallery2\sql\ for file uninstall.mysql.utf8.sql. Edit the file and remove the comments in front of the drop commands.

(3) Standard uninstall

Use finally standard Joomla uninstall to get rid of all parts of RSGallery2

Raw database zone

zone.rawDatabase.png

The buttons lead to the pure content view of the database lists

(1) Configuration variables

Shows a list with actual values of all configuration variables

(2) Images list

Shows a list with the database properties of all images. This contains more columns as the normal image view.

(3) Galleries list

Shows a list with the database properties of all galleries. This contains more columns as the normal image view.

(4) Comments list

Shows a list with the database properties of all comments. This contains more columns as the normal image view.

Outdated zone

maintenance.zone.outDated.png

Door to old view of functions like image/galleries lists These buttons lead to the previous views of RSG2 around 2013 or beginning of J3x
the functionality is not granted as this old code is not maintained any more. Still it may be a hint what has improved over this time

(1) Configuration

%

(2) Mange galleries

%

(3) Manage images

%

(4) Upload single images

%

(5) Consolidate database

Don't use. It is only listed for completeness

Upgrade (from 1.x / 2.x) zone

maintenance.zone.outDated.png

(1) Database

Repair missing database tables, table columns and ... This function reassigns the actual SQL definitions. Therefore new tables, new columns are added and not supported columns are removed

This is useful when upgrading from a real old version and general list can not be viewed

(2) Create gallery "access" field

On upgrade from 1.x this table field was missing. Here it will be created and all values set to one

(3) Delete RSG2 base language files

Deletes RSGallery2 languages files in joomla base language folders. The RSG2 base translation files are located in ...\administrator\languages. These may overwrite new RSG2 language items kept in component language folder.
Use this function when an update installation does not overwrite "old" base language files and translations do not appear or appear as old.


Maintenance Slideshow configuration

Slideshow parameters can be changed here

Two files living within the slideshow code define the parameters and their values

  • templateDetails.xml

    Existing parameter and their default value are defined in section param.

  • params.ini

    The actual values are taken from this file. If a value is not defined here than the default value will be used.
    The format is parameter="value". The double quotes may be omitted

The slideshow code files reside in path on the server: ".../joomla/components/com_rsgallery2/templates/"

Path to edit configuration form

Goto maintenance -> Use button (1) Slideshow configuration

zone.RSGallery2

Slideshow edit configuration form

zone.RSGallery2

(1) Select the slideshow to edit

(2) Section slideshow parameter

The variables shown here are definitions for the slideshow prepared in Joomla edit format. These and their default value are defined in file templateDetails.xml in section "param".

On "Save parameter" all values are written into the params.ini file and will appear in below section

(3) Section slideshow file

The values in params.ini file set the actual used values and overwrite the default. Here the actual values are displayed in "INI" format. The format is parameter="value". The double quotes may be omitted. The values displayed are used when the slideshow is shown. If the file (text area) is empty then the standard values are used. The file is filled when the configuration parameters are saved. Lines with standard values are not needed and can be removed.

Save changes

zone.RSGallery2

The parameters may be saved by the buttons in the menu bar (1) or below the parameter area. (3)
The file area may be saved by the buttons in the menu bar (2) or below the parameter area. (4)

Tip:

Reset to default values

Delete the content of the file params.ini in the below section and save it (button in below section). Afterwards save the parameters (button in above section). All default settings will appear in file parameter definition area.


Maintenance Consolidate image database

In cases where the upload got stuck you may get an error message but can't tell how far the process got. Here you can check the consistency of image references in database and files found in the images folder of RSGallery2

This function checks the links of images between image files and database assignments. It finds left over items like orphaned files or database image reference with missing file

How to get there

In "control panel" select Maintenance

Upload startview

There select in section "Repair zone" the button "Consolidate image database".

Upload startview

This will lead to a page where it is checked whether there are database entries for missing images or for images with no database / gallery connection

Result of checks

On opening the form or clicking on "Repeat checking" the system is checked and the result is displayed.

Upload startview

In (1) appears the list of files with "missing parts".

(2) Area with filename and check box to select images for further actions -> (7)

(3) Area with state of image. On green the item exists an red it is missing

(4) Direct action buttons. On click the task is performed on the file of the rows

(5) The parent gallery of the file in the row is listed and one of the matching images is displayed

Area with state of image.

Upload startview

On green the item exists an red it is missing (1) Each column indicates a file missing or existing

For file origin folder see configuration settings * Original folder: High resolution file. May be not saved on upload if prohibited in configuration * Display folder: File with defined resolution on upload. It will be used in slide shows * Thumb folder: Thumb size resolution files used in gallery view. * Watermark folder: This column/files will only appear if this feature is activated in the configuration. The filename in the folder may not match the used filename in database or the other image folders

Direct action buttons

Upload startview

On click the task is performed on the file of the rows Similar to the button in the header area these button issue immediate task on the image references(items) of this row

(1) Create missing images in row

(2) Assign gallery name

(3) Repair all issues in row

(4) Remove items in rows

More detailed description can be found below when the list buttons are explained

Action buttons for selected images

Upload startview

The above buttons can be used for selected file lines

(1) Create database entries

  • Adds database references to the selected files

(2) Create missing images

  • Used the original or display image to create the missing ones. If only the thumbnail is given it is used also but the result may not be very bright.

(3) Create missing watermarks

  • If watermark is selected in the configuration watermarked files are created for the selected files

(4) Assign gallery

  • Above the file list on the right side a gallery can be selected. On clicking this button the selected files will be bound to the gallery

(5) Remove items in rows

  • Does delete all existing connected items of the selected files. Deletes the references in the database and the existing files. Here all obsolete data may be cleaned.

(6) Repair all issues

  • This button fixes all missing references. It creates database references and missing image files.

Assignment of image(s) to parent gallery

Upload startview

On the right side above the image list the user can define the parent gallery to be used in image action. The gallery can be assigned with a button "Assign gallery" within the image row or for all selected images with the similar button on top of the page.

If Button "Repair all" is clicked and a gallery is selected this gallery is assigned.

"Lost" database file references

If no files exists to a "lost" database item the result looks like following. Upload startview

In this case it is best to select the line and use button "Remove items in row" to delete this item in database.

Back door assignment of images to existing galleries

A indirect way to upload images to RSGallery2 is to copy of the image(s) to the RSGallery2 original folder. Go to "consolidate images" view.

1. Upload image

Copy your file per FTP into folder .../Joomla/images/rsgallery/original.

2. Create files and database reference

Upload startview

(1) Use button "Repeat checking" so the image is found
(2) If the image exists it is marked here
(3) If the image exists it is displayed here
(4) Select the parent gallery
(5) Select the line(s) with clicking on marker in front
(6) Use button "Repair all issues"

If all goes well then the line of the selected image(s) will disappear in the next display of the page


Control Panel

Upload startview

(1) Function buttons

A click in the grey area will lead to the named section.
More see below

(2) RSGallery2 overview Tells about installed version and tells about interesting RSGallery2 links

(3) Last galleries and images overview area Shows a list of the latest galleries and a list of the latest images

(4) Credits

A click on credits opens an area where all the contributors to RSGallery2 are mentioned. More below

(5) Info about version and copyright

Function buttons

Upload startview

(1) Configuration

Enables the configuration of Image settings, Display settings and MyGallery settings

(2) Manage Galleries View gallery list , create new galleries, edit gallery, publish ...

(3) Upload Opens view for upload with "Drag and drop", upload "from Zip" or Upload "from server folder"

(4) Manage images View images list , create new images, edit image, publish ...

(5) Maintenance For maintenance exist a "Repair Zone" where content can be checked for consistency, a "Danger zone" to remove the component and a Raw database zone" to see more content of gallery and images list.

credits

Area where all the contributors to RSGallery2 are listed. See parts in image below.

Upload startview

Finish it for good

How to remove RSGALLERY2 completely

(1) Use Maintenance -> Purge tables

This removes the database content and the image files

(2) Prepare the remove of database table structure

Search in admin rsgallery2 folder \administrator\components\com_rsgallery2\sql\ for file uninstall.mysql.utf8.sql. Edit the file and remove the comments in front of the drop commands.

(3) Standard uninstall

Use finally standard Joomla uninstall to get rid of all parts of RSGallery2