Table of content

Introduction

Extensions

Functionality

Installation

Check if installation was made correctly

How does it work

Deinstallation

Configuration of YASIG plugin

YASIG gallery syntax

Configuration of yasiguncle plugin

FAQ (Frequently Asked Questions)

Support, bug reports

Automatic processing of pictures, client oriented

Team

Appeal

 


Introduction

As it is with every kind of content, also photo gallery is used for information exchange between:

  • Author - maker of a web page and
  • User - person willing to see a content created by the Author (viewer).

Specific role of Author is to choose set of pictures which will be presented on Internet to a User. This set of pictures is called gallery. Actions related to preparation of pictures are carried on by Author at so called backstage of web page, so after log on to backstage. Thanks to YASIG preparation of gallery is to some degree automated, what speeds up the process.

From User point of view pictures are presented as pictures reduced in size, so called miniatures. After One clicks in any of miniatures, the picture in original size is shown. With aid of keyboard or mouse it's possible to move over the rest of pictures from within gallery set.

To sum up, YASIG is photo gallery solution which with aid of few Jooomla! lets you for:

  • processing of photos, that will create Author's gallery,
  • photo presentation to persons willing to see them, to Users viewers of our web page.

Processing of pictures (e.g. reducing of size, adding of a frame around pictures etc.) is done at server side, so at first photos have to be send to server. Such way of processing might be convenient to socially oriented web portals. All Author of gallery is required to do is just transfer of chosen files to specified directory at server.

Set of YASIG extensions is compatible with Joomla! ver. 2.5.x. It makes use of Javascript JQuery library in quite intelligent way.

Correctly processed graphical files consists of .JPG and.PNG pictures.

To display pictures in fancy way it's used well known Lightbox effect, but truly it's slimed down 'brother', Slimbox.

For purpose of picture processing (shrinking, adding border etc.) GD PHP library is used.

Return to Table of Content

 


Extensions

Extensions which are parts of YASIG solution are described in the following table:

No. Type of extension
Extension name
Extension cathegory
Function
1. plugin plg_yasig content Display of photo gallery.
2. component com_yasiguncle content Engine used for picture processing.
3. plugin plg_yasiguncle editors-xtd Extension of content editor.
4. package pkg_yasiguncle - Installer / deinstaller of remaining extensions.

 

Extension plg_yasig may be used standalone. One may by oneself process picture files (more about this in chapter Automatic processing of pictures) and by oneself prepare gallery call (more about this in chapter YASIG gallery syntax).

Extensions com_yasiguncle and plg_yasiguncle always should be installed together with extension plg_yasig. Standalone installation of these extensions is pointless because by doing so one will not gain any functionality.

Extension pkg_yasiguncle lets for quick and easy automatic installation of all extensions.

Return to Table of Content

 


Functionality

Functionality depends on one's point of view:

  • Author or
  • User.

 

From an Author point of view:

Function Description
Textual form of gallery code.

Simple syntax of gallery code. Code of the gallery contains only some text. As a consequence, future changes to a gallery are very straightforward and quick. All is required to do some changes is just text editor. Internet browser doesn't have to receive each gallery picture one by one, only gallery text. It speeds up the process of content adjustment.

Placing gallery with pictures is just placing of certain set of characters with specified order and meaning (syntax), limited with braces: {...}. Engine which processes www site (Joomla!) will take care to interpret such a text string in a way that for User it will be visible as picture gallery.

Optional text description to each gallery picture.

Optionally any text description could be added to any picture. A comment is displayed to User if one will move mouse cursor over a miniature or, after click in any photo miniature, at the bottom of the photo. Comments aren't placed in separate file or in file header. They are present in body of article content. Thanks to that it's possible to edit them easily with ordinary text editor.

Google search engine indexes picture file names as well as picture comments.

Either picture file names, either text strings (comments) are indexed by Google search engine. It means that after gallery is ready, file names and comments might be searched with use of Google.

Full control of the Author over size and order of the photos in gallery.

Author of gallery has full control over size and order of photos. Size of the photos depends only on Author preferences. Change of the photo order in the gallery is as simple as text edition. It could be done as copy paste combination in text editor.

Quickness

Many photo galleries works as follows: in code there are storied only information about photo location, and its original size. Just on time when User starts to browse photos, the gallery engine alters size of photos, keeping resized versions temporarily in cache memory of server. When user stops browsing the temporary copies are removed. Operation of photo resizing takes time and a lot of server resources like memory and processor time. From User point of view a time needed to resize photos is added to a time required to get photos from its origin. Everything is fine if Author's web page is visited by small number of Users and each User browse another gallery. Lets consider situation when there significant amount of Users. Then it might be a case that server won't be able to quickly and efficiently process all the photos and what's more User will have to wait much longer for the final effect: resized photo.

YASIG just reads photos already prepared to be viewed. There is no overhead due to photo processing. What's more server is able to serve many Users concurrently. So it could be said that YASIG pays off at its best in case of big, popular galleries...

Saved disk volume

YASIG just displays previously prepared photos. Resized, shrinked photos of the time are much smaller then original photos. As a consequence Author can save some server side disk volume. For example typical photo in size of 2816 x 2112 pixels takes about 2.4 MB in volume. The same photo resized down to 640 x 480 pixels takes only 81.6 kB and resized down to 200 x 150 pixels takes only 18.5 kB. So it could be clearly seen we are able to spare about 2.3 MB of disk volume per each photo.

 

From a User point of view:

Function Description
Quickness

Many photo galleries works as follows: in code there are storied only information about photo location, and its original size. Just on time when User starts to browse photos, the gallery engine alters size of photos, keeping resized versions temporarily in cache memory of server. When user stops browsing the temporary copies are removed. Operation of photo resizing takes time and a lot of server resources like memory and processor time. From User point of view a time needed to resize photos is added to a time required to get photos from its origin. Everything is fine if Author's web page is visited by small number of Users and each User browse another gallery. Lets consider situation when there significant amount of Users. Then it might be a case that server won't be able to quickly and efficiently process all the photos and what's more User will have to wait much longer for the final effect: resized photo.

YASIG just reads photos already prepared to be viewed. There is no overhead due to photo processing. What's more server is able to serve many Users concurrently. So it could be said that YASIG pays off at its best in case of big, popular galleries...

Photo browsing with use of mouse

To browse sequentially gallery photos one can simply use a mouse by clicking. All what has to be done is click to the left or right half of a photo of currently displayed photo. Then additional buttons are temporarly overlayed for a time being when mouse cursor is placed over a photo area:

  • next photo button is displayed if right half of a photo is clicked,
  • previous photo button is displayed if left half of a photo is clicked.
Photo browsing with use of keyboard (shortcuts)

To browse sequentially gallery photos one can simply use a keyboard (shortcuts):

  • next photo is displayed if 'right cursor' (->) is pressed down,
  • previous photo is displayed if 'left cursor' (<-) is pressed down,
  • to exit gallery just press 'Esc' key.

 Return to Table of Content

 


Installation

Installation is possible in two ways:

  1. Use of installation package. This is default, recommended method of installation. Installation package consists of scripts which are run during the time of installation. The scripts take care to put all the required files of all extensions in the proper folders.
  2. Manual installation of each particular extension.

Typically to perform installation task it's required to have privileges of www site administrator.

 

Installation of YASIG with use of installation package

Below it's described in details the default method of installation.

  1. Download installation package:

Installation package is a file where it's name consists of section "pkg" and it's extension is equal to .zip, e.g. "pkg_yasiguncle_j.2.5.zip". Please keep in mind location where the file was saved.

 

  1. Log in to background of your web site

In address field of your web browser put address of your web site finished with "administrator" section, for example:
http://www_address_of_your_web_site.extension/administrator

After a while your screen should look like neighbouring picture.

Eng LogowanieZaplecze

 

  1. Installation of package file
Open the extension manager: menu -> Extensions -> Extension manager. Eng WyborExtensionManager
Choose Install tab. Eng InstallTab
Push the button "Browse" and navigate to location where you've saved installation package (e.g. "pkg_yasiguncle_j.2.5.zip"). Eng WskazPaczke
Push the button "Upload & Install". Eng Instaluj
After a while there will be displayed message with confirmation of correct installation ("Installing package was successful"). Eng Zainstalowano

Scripts which are run automatically during installation turn on all plugins.

Short film showing how to install all extensions and check if extensions are installed properly:

 

Return to Table of Content

 


Check if installation was made correctly

In order to check if plugin is installed correctly open Extension manager: menu -> Extensions -> Extension Manager. Eng WyborExtensionManager
Open "Manage" tab. Eng Zarzadzanie

In the field "Filter" put the string "yasig" and push the "Search" button.

After a while one should see a table similar to the one presented at neighbouring picture with 4 installed extensions:

  • com_yasiguncle,
  • pkg_yasiguncle,
  • plg_yasig,
  • plg_yasiguncle.

These are all extensions belonging to yasig solution.

Eng FiltrujYasig

Return to Table of Content

 


How does it work

What actions should be taken by Author to prepare a gallery:

  1. selection of photo set, which will be presented to users in form of a gallery,
  2. upload of photo set to Joomla! server, in an input folder,
  3. make output directory, if necessary,
  4. open article, where gallery will be located.

All the rest, as follows:

  1. processing of photos: preparation of normal size photos and thumb photos according to set of rules,
  2. preparation of YASIG gallery calls,
  3. insertion of YASIG gallery calls into content of article

will be made automatically by yasiguncle extensions (component and editor-xtd). If necessary some short description for pictures may be entered in article body by Author. By default, automatically, as picture comment n a picture file name is entered.

At the beginning it looks for example as follows:

  1. Set of extensions is correctly installed,
  2. in the input folder (e.g. images/stories/yasig_input) Author have uploaded e.g. 2 pictures, as desribed in the table:
File name
Approximate file size
Picture size [px] x [px]
IMG_7952_KaluznicaCzarnozielona.JPG 1.6 MiB 1704 x 2272
IMG_7954_KaluznicaCzarnozielona.JPG 1.5 MiB 1704 x 2272

 

lt="Eng Steaphotos from its orig/storieAuthor ha6 e.g.ng>'fimages/storiese36" />'load drc=(/> 5 alreadeign: justify;xg> buttoe displayedtories/201tton. If tE_1.png=/cp://extsert yle="width: wpnd 'load drc=(/n-wrong> butg-output inaerver won't be able oad drc4" /> inpfong>'load drc=eall one storiesC of s clicked,0tquip placing inple="ld> (one storiesC of s clicked yriesC of5d.

e>
p=hxould be

When ttance of t. 5 alreadeign: justify;xg> buttoe dist fowt inpm;?idth="62777774 instawzarnozielona.JPG

5 alreadeign: justify;xg> buttoe dist fowt inpm;?idth="62777774 in64awzarnozielona.JPG 5 alreadeign: justify;xg> buttoe dist fowt inpm;?idth="62777774 instawzarnozielona.JPG 5 alreadeign: justify;xg> buttoe dist fowt inpm;?idth="62777774 in64awzarnozielona.JPG 170>

Author has chosen an article, where YASIG photo gallery will be placed, opened this article, put the cursor in article text content in the place where YASIG gallery call will be placed.

Eng Artykul

Just under the editor window there is visible 'yasiguncle' button. If the button is clicked, the wizard will come out. With assistance of the wizard all next tasks are made.

Eng EditArticle
Mentioned button. PrzyciskYasig

When 'yasiguncle' button is clicked, screen will be covered with neighbouring window. This is mentioned wizard. Author of a gallery should now configure it by changing at least some of the options. First of all one should indicate input folder, so the folder where pictures were uploaded. Later the output folder should be specified, so the folder where processed files will be placed. (Author may change also all other options, which are explained in details in the following section of this guide, Configuration of yasigunucle plugin).

Eng Step2 1

Author may change options 'Input folder' and 'Output folder' in two ways. The first way is clicking in second text row below the text 'Input folder' and 'Output folder'. In consequence small window with list of server folders will be opened. In this way, with use of mouse, one can specify existing folders. The second way is placing input and output folders manually. For this purpose the first text input fields are prepared, just below the text 'Input folder' and 'Output folder'.

At neighbouring screen gallery Author already changed required options. If the visible link Show options is clicked, one may change all other options.

When all the options follow requirements of gallery Author, one should click button 'Go to next step!' to proceed.

Eng Step2 2

On the screen small turning circle will be displayed. It shows time of picture processing. In a moment syntax of YASIG gallery will be displayed together with button 'Insert yasig-output into article'. Click this button with mouse.

Eng Step3 1

When the mentioned button is clicked, in article content correct YASIG gallery body will be placed. All one have to do now is saving the article.

Eng Step3 2
1.6 MiB 1704 x 2272 1.6 MiB 1704 x 2272 1.5 MiB 1704 x 2272 1.5 MiB 1704 x 2272