yappa-ng Regular Documentation

yappa-ng Manual

Special Features of yappa-ng


Scope

What is NOT in the scope of this Manual:

What IS in the scope of this Manual:

Index




Random Images for HTML-Homepages

You can display a random image from one of your yappa-ng Albums on your HTML-Homepage to make a link to your yappa-ng Gallery! You need no additional PHP or Perl script - the only thing you need is a correctly installed yappa-ng Gallery! You are not limited to the thumbnail size - you can choose every valid imagesize!
(Valid are all resize sizes you have defined in the yappa-ng setup. If you are not the yappa-ng administrator: valid image-sizes are all the sizes you can select to view a Single Image)

Here are some examples with the HTML-Code you have to insert into the HTML-page (and with explanations!) (This works in every simple HTML-page!):


You can view an example on the yappa-ng Homepage: example of "Random Image"

->Back to TOP




NEWS or WELCOME Pages

The NEWS-, INTRO- or WELCOME-Page (it is all the same!!!) of yappa-ng is the page you can view when you start up yappa-ng. In the default installation you can read "Welcome to yappa-ng Photo Gallery! Congratulation! ...." in your default language (or English). I will call this page "NEWS-page" from here on, because the filename starts with "news_".


How can I change the default Welcome-Page of yappa-ng?

After installation there is a file with the name: "news_xxx.html" in the yappa-ng Main Directory (where the "index.php" is located). This is the NEWS Pages of yappa-ng for your default languages. (If I do not have a news file for your language there will be no newsfile!). The "xxx" is the language (ger=german, eng=english, ned=nederland,...). Each language has its own NEWS-file.

To make your own NEWS-Page all you have to do is make an own HTML-page and name it news_xxx.html (where xxx is the language where it will be seen). For details of the format of this HTML-page please read on in the next section of this manual: "The formatting / color of the welcome page"!

Hint: If you want to be sure every user sees YOUR news file (meaning: you make the newsfile only in one language, but use the "autodetect language" feature for the yappa-ng "text & buttons") you should name it "news_all.html" (see the details)!

->Back to TOP




The formatting / color of the welcome page.

Each global "news_xxx.html" is a standard HTML-page where you can put in everything you want and what is possible in other HTML-pages like links, images, banners, own hitcounters for website-statistics,....
It is ok to generate this news file (or fileS if you want to have your news in different languages) with a HTML-editor like FrontPage, Dreamwaver, bluefish,...
But you will have to edit the HTML-file before you upload it into the yappa-ng Main Directory!
You have to delete the complete HTML-header / starting HTML-tags: Beginning with the <!DOCTYPE, <HTML>, <HEAD> inclusive <BODY>!
Do the same at the end of the file </BODY> and </HTML>.
The news-file is integrated into an already existing HTML-table! If you upload the unedited HTML-file the yappa-ng themes formats will be overruled by the formats defined in the news-file for most browsers!
You only have to do this once - the editor should not include it on his own during the next news upgrade of you.

->Back to TOP




News pages within the gallery.

You can have NEWS-pages within your Album-tree too if:

The news_xxx.html has to be in the photo album "/_data" directory of the album where it shall be displayed!
All other infos regarding the NEWS-pages apply exactly as they do for the central yappa-ng WELCOME page!

Hint: You can give a "Random Image" (or more) of the subalbum(s) into the NEWS-page :-)!

->Back to TOP




NEWS / WELCOME pages only for one language (no need for more).

If you want to maintain the NEWS- /WELCOME-page for your gallery only in one language (if you do not want to make NEWS / WELCOME pages for differnt languages, but you use the "autodetect language" feature for the yappa-ng "text & buttons") take the language-shortcut of "all" (news_all.html).
If a "news_all.html" exists only this one will get presented to the users - there will be no search for news-files in another language anymore! You can be sure it gets presented to everyone.
This works for the global NEWS-page in the yappa-ng Main Source directory as well as for other NEWS pages within photo albums!

->Back to TOP




Integrated, Album-and Language-specific Links to Reports outside of yappa-ng!

You get an additional album-link (meaning a link in the line with Top10, Admin-Login,...) if you:

Usage of the report_xxx.inc.php: If you want to know how this works take a look at the Admin-demo in the DEMO-Gallery (switch to GERMAN LANGUAGE [=Deutsch]):
[External link]: http://www.zirkon.at/yappa-ng_demo/index.php?album=/admin_demo

->Back to TOP




Structure your yappa-ng Gallery!

It's easy to install yappa-ng and start putting one album after the other into the Photos Main Directory.

But think one moment: After some time the "Left Album-Navigationbar" where you select all the albums will get longer and longer! You will have to scroll really long down to get to the last album in the row.

To avoid this the recommended approach is a structured design from the very start on!
Consider the following example:
yappa-ng shall be the gallery for your party photos, but you want to use it for your family-albums too:


The structured approach is easy put into effect! Here is the above example explained:

I think you can go on from here without further explanations! :-)

Of course you can create the directories manually if you have access to the Operating System. But be sure to copy the files "config_album.inc.php" and the file "hits.log" into _every_ directory! yappa-ng will only accept directories where these files are existing! (If you create the albums (=directories) with the Admin-Interface these files get created automatically!). Be sure that the fileaccess and fileowner rights are correct!! :-)

For a more detailed description which files are needed within an album-directory and how to create albums manually go to the setupinfo-photo_root.html

Hint: You can move a complete Album with all the image-hitcounts, settings, Album and Image descriptions from one directory-branche to another with moving the directory. The only thing you will lose (meaning start with zero) is the album-hitcounter.
If you want to make it a "clean move" you should copy the directory to its destination (instead of moving it) and after this delete the old album with the help of the Admin-Interface. By deleting the album with the Album-Admin Delete you will delete all cached images too!

You can see an example of a structured Gallery if you view my "private" Gallery - the "ZIRKON Box Foto Galerie".

->Back to TOP




Videos, Music and other non-Image Files.

yappa-ng is a PHP Photo Album - meaning that it will collect and display photos and images.
Starting with release 2.2.1 yappa-ng allows you to upload and share non-image files like videos, audios, pdf, office-files,... too!
In theory this should work with all and any files.
Just be aware of the filesizes (can be really huge with videos!!) and that the Admin Upload is restricted in filesize (see the Setup Tool!).
And be aware that some filetypes cannot be viewed online with some Operating Systems and/or Browsers. Many filetypes need installed programs or installed Browser-Plugins to be viewed online! (Example: You cannot view a Windows Powerpoint Presentation embedded in your browser on a Linux System -> but you can download it!!!)


The difference between "Images" and "Non Resizeable Files".

yappa-ng looks at the file extension (like .jpg or .png or .avi .....) to decide, which filetype (or mime-type) each file is. For yappa-ng there exist only 2 categories of files:

yappa-ng checks for the permission of filetypes during the upload process in the "Upload Images" section of the Admin Menu. If its not one of the permitted filetypes it gets rejected.
But even if you FTP or move the file into the album it gets checked during the yappa-ng script run and will not get displayed if its not permitted! If you change the permission in the Setup Tool for a special filetype (enable or disable it) the file will appear/disappear. You can specify the permitted filetypes only globally (and not for each album differently)!

Within the permitted filetypes yappa-ng differentiates again between 2 mime-type (=filetypes) categories:

Images and Photos

In the meantime there are many Photo and Image formats in existance. To be able to resize an image it has to be supported by the GD library or ImageMagick. Both support more and more imagetypes.
All thumbnails, icons and sizes are created automatically from yappa-ng. Thats the purpose of an "Image Gallery"!
In addition you can cache the resized images to get faster access.

"Non Resizeable Files"

yappa-ng support for "Non Resizeable Files" started with video/movie files like avi, mpg or mov in release 2.2.0.
Starting with release 2.2.1 you may collect and display (and share) more or less all known file formats.
The only restrictions are:

->Back to TOP




The Preview, Symbol or Icon of a "Non Resizeable File".

There are 2 methods to visualize a "Non Resizeable File" within yappa-ng:

Example for a Snapshot:
The filename is: iAm-aVideo.avi
The snapshotfile that will be used: _iAm-aVideo.jpg

The one (and only!) drawback of this implementation is the fact, that images starting with an underscore ("_") will not be shown if they are standard images themselfs (without corresponding "Non Resizeable File")!

IMPORTANT: If you delete this image with the "Delete Images" tool of the Admin Interface the corresponding "Non Resizeable File" gets deleted too (automatically)!!
If you delete this image without the "Delete Images" tool of the Admin Interface the "Non Resizeable File" will be kept of course, but the corresponding cached images will not get deleted too!

->Back to TOP




How to add an additional or change an existing mime type (file type).

To add a new mime type or change the icon or thumb for an existing mime type you have to edit the file config_mimetypes.inc.php

Add an Image.

If you want to add an image format which is supported by the image-tool you use for yappa-ng (ImageMagick or GD Library) you go to the file config_mimetypes.inc.php.
One example is shown here:

     "jpg" => array( 
              "mime" =>"image/jpeg", "resize" => TRUE, 
              "filetype" => "image", 
              "icon" => "", "iconsize" => "", 
              "thumb" => "", "thumbsize" => ""), 

The first "jpg" is the file extension for the files of this mimetype.
Very important is the part "mime" =>"image/jpeg",, because here you define the mimetype for the browser. If you are not sure which mimetype your new filetype has please search in the internet. You have to know this if you add a new mimetype!!

The next part "resize" => TRUE, tells yappa-ng that it is a "Resizeable Image". If you say TRUE than ImageMagick or GD (whichever you have configured for your setup) will try to resize the image! If its not supported by one of those you will get "broken images" instead of the resized images!

For the "Resizeable Images" you do not need icons and thumbs - they are created directly from the image! :-)

Add a "Non Resizeable Filetype".

If you want to add any other ("Non Resizeable") filetypes take a closer look at this example (in file config_mimetypes.inc.php):

     "mov" => array( 
              "mime" =>"video/quicktime", "resize" => FALSE, 
              "filetype" => "video", 
              "icon" => "images/movie_mini.jpg", "iconsize" => "width='50' height='40'", 
              "thumb" => "images/movie_thumb_mov.jpg", "thumbsize" => "width='100' height='81'"), 

The first "mov" is the file extension for the files of this mimetype.
Very important is the part "mime" =>"video/quicktime",, because here you define the mimetype for the browser. If you are not sure which mimetype your new filetype has please search in the internet. You have to know this if you add a new mimetype!!

The next part "resize" => FALSE, tells yappa-ng that this is a "Non Resizeable Filetype" and that yappa-ng should never try to resize this file with ImageMagick or GD Library! You have to say FALSE here! If you say TRUE than ImageMagick or GD (whichever you have configured for your setup) will try to resize the image and fail! If its not supported by one of those you will get "broken images" instead of the resized images!

Next comes the definition of the icons (mini previews, should be maximum 50 height / width). Take a look at your setup what size you defined for the Mini Preview icons. Pay attention to the quotes-setting (doublequotes/singlequotes) - this is important!

The last one is the definition for the thumbnails. For these goes the same as for the icons. Default maximum width/heigt is 100 (if you did not change this in the setup!)

You have to give the information for icon/thumbs even if you have Symbols or Icons for your "Non Resizeable File".!!

Change the Icon or Thumb for a "Non Resizeable Filetype".

If you want to add any other ("Non Resizeable") filetypes take a closer look at this example (in file config_mimetypes.inc.php):

     "mov" => array( 
              "mime" =>"video/quicktime", "resize" => FALSE, 
              "filetype" => "video", 
              "icon" => "images/movie_mini.jpg", "iconsize" => "width='50' height='40'", 
              "thumb" => "images/movie_thumb_mov.jpg", "thumbsize" => "width='100' height='81'"), 

You can see the "icon" and the "thumb" part. You can change this to any mini preview and thumb as a symbol for this filetype. Just have a look at the sizes. Take a look into the Setup-Tool what sizes you defined for the Mini Preview Icons (default: 50x50) and the thumbnails (default: 100x100) in your setup.
100x100 means that the Maximum pixelwidth is 100 pixel (width OR heigth depending on the orientation landscape or portrait), and the other length is according the original properties! (A landscape 640x480 would be 100x75, a portrait 480x640 would be 75x100). The same applies to the 50x50. :-)

Pay attention to the quotes-setting (doublequotes/singlequotes) and the colons - this is important!

->Back to TOP




Languages, Language Support and Translations.

The principle of language support is that you have all texts, which are displayed in yappa-ng, in a separate file for each language - the language-definition-files (=languagefiles).
If you change language yappa-ng just loads the new file and uses all the names (text AND filenames) that are defined in there.
You need at least one languagefile, because if you don't have at least one there will be NO text in yappa-ng!
yappa-ng will try to detect automatically which language the user accepts and if this language is installed it will present the user automatically with this language.
To make sure yappa-ng knows which languagefile it should use on first connect with a user (if you have the "language-autodetect" off or you do not have the language installed which your user wants) you have to define a "default" language.
And if you decide to disable language-support yappa-ng still needs at least one languagefile. Disabling language-support only means, that you will get no longer the option to change the language in the right upper corner. (The language-change-menu will not appear!).


The "Language Autodetection".

As yappa-ng gets translated into more and ever more languages the chances have increased that the user-preferred language is available.
yappa-ng tries to read the information provided from the client-browser of the user about the preferred/accepted language.

If the language is autodetected yappa-ng switches to this language with all text of the program itself and with the user created files like the album description or the image captions or maybe an external report file!
If the language is not available yappa-ng presents the default language.

If the desired language is available yappa-ng switches automatically to this language.

You can switch this feature on/off in the Setup Tool


->Back to TOP




The "Intuitive Language Selection"

With the "autodetect_language" feature enabled the possibility is high that a user from another country with another language than your default homepage language does not see your album title, album description and image captions.

To avoid this dilemma there is the feature "intuitive language selection".
Here is how it works:

This guy has yappa-ng in Spanish, but will NEVER see your hard work in commenting all images and making a decent album-title and a nice album-description.

With "lang_intuitive" set to "yes" this Spanish guy keeps yappa-ng in Spanish - but gets your English (or other Default-language) album descriptions, image captions,...
If you have a Spanish album title created he gets OF COURSE his (= Spanish ) version!

A really nice feature!

This feature does NOT affect your yappa-ng language selection (be it autodetected, selected or default). The language of the program (yappa-ng) itself (explaining texts, buttons,...) is untouched.
This feature works only with the language related user created/edited files:

These are the files where every language has its own (separate) file.
It works only for the DEFAULT-language!

You can switch this feature on/off with the Setup Tool.


->Back to TOP




The interaction of "Default Language", "Intuitive Language Selection", "Language Autodetection" and disabling Language Support.

detailed description


->Back to TOP




Translating missing parts within an existing Language file.

If you are using yappa-ng and you find some missing translations in your own Language it would be GREAT if you could translate them and send them to me!

If this is possible please here is how to do it:

When you send the file (or the parts) to me please make sure that something with "yappa-ng" is in the subjectline because otherwise its possible that it gets in some of my SPAM-filters! :-(

Please tell me if you did this as a "One-Time Job" and do not want to hear anything from me again or if I may send you the new words/sentences for new releases and you will translate them too. This will be only some view words/sentences for each release! THAT WOULD BE GREAT!


->Back to TOP




Translating yappa-ng into a "NEW" language.

If you are using yappa-ng and your own Language is not available you may want to translate everything to your Language.
First you have to deside if you translate the complete language (including the "Admin Section") or only the "Public Part".
Some translators say that in their country English is so widespraid that they do not need to translate the Admin Section. But more and more yappa-ng Sysadmins take the advantage of the "Upload-User" and this Upload user uses the Admin Section too.
If it is possible please translate the complete languagefile!

How to do it:

When you send the file to me please make sure that something with "yappa-ng" is in the subjectline because otherwise its possible that it gets in some of my SPAM-filters! :-(

Please tell me if you did this as a "One-Time Job" and do not want to hear anything from me again or if I may send you the new words/sentences for new releases and you will translate them too. This will be only some view words/sentences for each release! THAT WOULD BE GREAT!


->Back to TOP







Have Fun!

->Back to TOP






Part of yappa-ng Documentation by Fritz 'wizard' Berger: >> yappa-ng Homepage <<