Files Provided by BPP
This is a description of the files that are provided in the distribution
of BPP. All of the files are used by BPP to generate albums.
The table below lists each files provided by BPP, grouped by containing
folder and linked to the detailed information in the alphabetical file list
that follows. The containing folder headings are linked to a description
of the purpose of the files within the folder.
Folders
| Folder name: |
BluPlusPlus Folder |
 |
| Purpose: |
Main skin folder containing all BPP-provided files |
| Location: |
|
| Notes: |
|
| Folder name: |
bsh Folder |
|
| Purpose: |
Contains BPP specific beanshell code files |
| Location: |
BluPlusPlus |
| Notes: |
Beanshell files are code files where BPP does much of its processing. According
to the beanshell site
: “BeanShell
is a small, free, embeddable, Java source interpreter with object scripting
language features, written in Java.
BeanShell executes standard Java statements and expressions, in addition to
obvious scripting commands and syntax. BeanShell supports scripted objects
as simple method closures like those in Perl and JavaScript(™).” In
order to significantly alter how BPP handles many of its features, one
must feel comfortable altering these bsh files.
|
| Folder name: |
config Folder |
|
| Purpose: |
Contains configuration files for audio & video support |
| Location: |
BPP |
| Notes: |
|
| Folder name: |
docs Folder |
|
| Purpose: |
Contains documentation files |
| Location: |
BPP |
| Notes: |
|
| Folder name: |
frames Folder |
|
| Purpose: |
Contains XBorder Filter specification files used in generating
frames
|
| Location: |
BluPlusPlus |
| Notes: |
Users can create their own custom frames by creating ‘.xbp’ (XBorder
Filter properties) files. More information is here.
|
| Folder name: |
includes Folder |
|
| Purpose: |
Contains code files that are incorporated into slide
and index pages during album generation
|
| Location: |
BPP |
| Notes: |
|
| Folder name: |
plugins Folder |
|
| Purpose: |
Contains java code files that are used to make BPP work |
| Location: |
BPP |
| Notes: |
|
| Folder name: |
res Folder |
|
| Purpose: |
Contains JAlbum and skin resources that are used during album
generation; these resources are copied to the album output folder.
|
| Location: |
BluPlusPlus |
| Notes: |
All skins have a res folder. |
| Folder name: |
BluPlusPlus-->styles Folder |
|
| Purpose: |
Contains ‘placeholder’ style files |
| Location: |
BluPlusPlus |
| Notes: |
JAlbum expects style files to placed in this location. In order to
allow for subfolders to have their own style selections,
the ‘real’ style
files are located elsewhere, in BPP-->res-->styles. Therefore, BPP
places empty ‘placeholder’ style files here with the same name
as the actual style files. This permits JAlbum to recognize
the various styles so that they can be chosen on the JAlbum main window.
See Altering and Creating Styles in BPP for more information. |
| Folder name: |
texts Folder |
|
| Purpose: |
Contains language specific files. |
| Location |
BluPlusPlus |
| Notes: |
|
| Folder name: |
res-->actions Folder |
|
| Purpose: |
Contains the various icon sets that are distributed with BPP |
| Location: |
BluPlusPlus-->res |
| Notes: |
Users can create their own icon sets and place them in a folder
within the actions folder; they will then be available for selection on
the ‘Icon Set’ drop-down
menu on the BPP
General tab
|
| Folder name: |
res-->js Folder |
|
| Purpose: |
Contains javascript code for adding functions when generated albums are viewed |
| Location: |
BluPlusPlus-->res-->js |
| Notes: |
|
| Folder name: |
res-->php Folder |
|
| Purpose: |
Contains php program files for the Viewer Remarks feature |
| Location: |
BluPlusPlus-->res |
| Notes: |
|
| Folder name: |
res-->styles Folder |
|
| Purpose: |
Contains ‘real’ style files |
| Location: |
BluPlusPlus-->res |
| Notes: |
BPP places the ‘real’ style files here in order to allow for
subfolders to have their own style selections. JAlbum
expects style files to placed in another location (BluPlusPlus-->styles).
BPP therefore places empty ‘placeholder’ style
files there. See Altering
and Creating Styles in BPP for more information
.
|
| Folder name: |
res-->styles-->stylename Folder |
|
| Purpose: |
Contains files that work with the correspondingly named css
file to implement a style
|
| Location: |
BluPlusPlus-->res-->styles |
| Notes: |
This folder is optional; if present, it contains any or all
of the following three files:
- background.jpg
- rule.gif
- theme.properties
|
| Folder name: |
res-->topbar Folder |
|
| Purpose: |
Contains topbar folders |
| Location: |
BluPlusPlus-->res |
| Notes: |
|
| Folder name: |
res-->topbar-->stylename Folder |
|
| Purpose: |
Contains image files to create topbars |
| Location: |
BluPlusPlus-->res-->topbar |
| Notes: |
Topbars can come in three different styles:
|
BPP-Provided Files
| File name: |
audio-block.inc |
|
| Purpose: |
HTML code used to process audio files in a browser when the audio control
console is present |
| Location |
BluPlusPlus-->config |
| Notes: |
By default, BPP uses the <embed> html tag to support audio files. Users
may edit this file if they wish to use different code for
audio files. |
| File name: |
audio-hidden-block.inc |
|
| Purpose: |
HTML code used to process audio files in a browser when the audio control
console is not present |
| Location |
BluPlusPlus-->config |
| Notes: |
By default, BPP uses the <embed> html tag to support audio files.
Users may edit this file if they wish to use different code for audio files. |
| File name: |
background.jpg |
|
| Purpose: |
An image file providing the background (‘wallpaper’ for
a given style).
|
| Location |
BluPlusPlus-->res-->styles-->stylename ƒ |
| Notes: |
Not all styles have backgrounds. |
| File name: |
black ƒ |
|
| Purpose: |
Contains the icons for the icon set “black” |
| Location |
BluPlusPlus-->res-->actions |
| Notes: |
“black” looks best against a light background |
| File name: |
bright-matte ƒ |
|
| Purpose: |
Contains the icons for the icon set “bright-matte” |
| Location |
BluPlusPlus-->res-->actions |
| Notes: |
“bright-matte” looks best against a light background |
| File name: |
camera.properties |
|
| Purpose: |
Contains focal length multiplier info for various cameras |
| Location |
BluPlusPlus-->config |
| Notes: |
The “focal length” is the distance from a camera
lens to the plane of the film or digital sensor. Most photographers are
familiar with this number when it is given for a 35mm camera. The actual
focal length for digital cameras is much smaller. The focal length multiplier
is a value used to convert the actual focal length of a digital camera
to its 35mm equivalent. When possible, BPP calculates this value based
on information contained in the EXIF information. When that is not available,
BPP pulls the focal length multiplier from the camera.properties file.
|
| File name: |
captcha.php |
|
| Purpose: |
Contains php code to support CAPTCHA security images. |
| Location |
BluPlusPlus-->res-->php |
| Notes: |
|
| File name: |
ChangesHistory.txt |
|
| Purpose: |
Gives details of changes to each version of BPP |
| Location |
BluPlusPlus-->docs |
| Notes: |
|
| File name: |
classic.gif |
|
| Purpose: |
An image file used to generate a topbar. |
| Location |
BluPlusPlus-->res-->topbar-->stylename ƒ |
| Notes: |
Each style has a default topbar associated with it. Screenshots
of topbars and information about how to alter the topbar
for a style is here.
|
| File name: |
classname.class |
|
| Purpose: |
A compiled java code file |
| Location |
BluPlusPlus-->plugins |
| Notes: |
|
| File name: |
classname.java |
|
| Purpose: |
A java code source file |
| Location |
BluPlusPlus-->plugins |
| Notes: |
|
| File name: |
common.js |
|
| Purpose: |
A javascript code file providing funtions needed to run
several BPP features
|
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
common-header.inc |
|
| Purpose: |
contains code to create header information common to slide and
index pages
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
connect.pht |
|
| Purpose: |
A php template file used to implement the Viewer Remarks feature |
| Location |
BluPlusPlus |
| Notes: |
|
| File name: |
dark-matte ƒ |
|
| Purpose: |
Contains the icons for the icon set “dark-matte” |
| Location |
BluPlusPlus-->res-->actions |
| Notes: |
“dark-matte” looks best against a dark background |
| File name: |
db_mysql.php |
|
| Purpose: |
Contain php code to support Viewer Remarks using a MySQL database |
| Location |
BluPlusPlus-->res-->php |
| Notes: |
|
| File name: |
db_postgresql.php |
|
| Purpose: |
Contain php code to support Viewer Remarks using a PostgreSQL database |
| Location |
BluPlusPlus-->res-->php |
| Notes: |
|
| File name: |
empty.gif |
|
| Purpose: |
A required JAlbum file that BPP does not use |
| Location |
BluPlusPlus-->res |
| Notes: |
|
| File name: |
favicon.ico |
|
| Purpose: |
File for icon that appears in a browser’s URL box when
an album is viewed
|
| Location |
BluPlusPlus-->res |
| Notes: |
|
| File name: |
folder.gif |
|
| Purpose: |
A required JAlbum file that BPP does not use |
| Location |
BluPlusPlus-->res |
| Notes: |
|
| File name: |
footer.inc |
|
| Purpose: |
contains code to create footer information common to slide and
index pages
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
frame_filename.xbp |
|
| Purpose: |
Contains XBorderFilter properties to create the frame with
the given filename
|
| Location |
BluPlusPlus-->frames |
| Notes: |
|
| File name: |
help.inc |
|
| Purpose: |
contains code to create the popup navigation tips box on slide
pages
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
html-header.inc |
|
| Purpose: |
Contains HTML code that appears at the very top of all slide and index
pages. |
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
hints.jap |
|
| Purpose: |
Used by the skin author to specify
the desired default values for JAlbum and skin user variables.
|
| Location |
BluPlusPlus |
| Notes: |
More information about hints.jap can be found here. |
| File name: |
index.bsh |
|
| Purpose: |
Contains beanshell code that is executed when index.htt is processed by
JAlbum
|
| Location |
BluPlusPlus-->bsh |
| Notes: |
|
| File name: |
index.htt |
|
| Purpose: |
An html template plate on which index pages are based |
| Location |
BluPlusPlus |
| Notes: |
index.htt (and slide.htt) are basically html pages that can be edited
to further customize BPP. However, there is a great deal
of beanshell/java code contained in the pages, and function
calls to other files (typically bsh files), so it can be
difficult to figure out exactly how to implement desired changes. Of particular note
is that much of the html generated for index pages is created
via ‘out.print’ commands
within the beanshell code rather than via the code of index.htt
|
| File name: |
index-bottom-navigation.inc |
|
| Purpose: |
creates navigation icons on the bottom of index pages if there
is more than one index page for a subalbum and if bottom navigation icons
are specified on the BPP-General tab
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
index-remarks.inc |
|
| Purpose: |
HTML code to support Viewer Remarks on index pages |
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
index-topbar.inc |
|
| Purpose: |
code to create the top blue bar on index pages |
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
index-top-navigation.inc |
|
| Purpose: |
creates navigation icons on the top of index pages if there
is more than one index page for a subalbum and if top navigation icons
are specified on the BPP-General
tab
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
init.bsh |
|
| Purpose: |
init.bsh is a beanshell file executed
every time an album is generated. The code creates the
BPP user interface. |
| Location |
BluPlusPlus |
| Notes: |
|
| File name: |
InstallationGuide.txt |
|
| Purpose: |
Gives info about how to install new versions of BPP into JAlbum |
| Location |
BluPlusPlus-->docs |
| Notes: |
|
| File name: |
keyboard.js |
|
| Purpose: |
Javascript code that provides for keyboard navigation within the generated
album.
|
| Location |
BluPlusPlus-->res-->js |
| Notes: |
See here for information
on how to customize the keys used for album navigation. This file works
together with nav-index.js or nav-slide.js to provide keyboard navigation
for both index and slide-image pages.
|
| File name: |
metatags-header.inc |
|
| Purpose: |
Beanshell code to support the inseration of HTML metatags into BPP
pages. |
| Location |
BluPlusPLus-->includes |
| Notes: |
Metatags, which help search engines, can be specified on the BPP-General
tab. |
| File name: |
movie.gif |
|
| Purpose: |
A required JAlbum file that BPP does not use |
| Location |
BluPlusPlus-->res |
| Notes: |
|
| File name: |
nav-index.js |
|
| Purpose: |
Contains variables and functions related to keyboard navigation in an index
page.
|
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
multiple-onloads.js |
|
| Purpose: |
multiple-onloads.js is a javascript support file to ensure that the ‘onload’ event
handler correctly deals with different browsers. |
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
nav-slide.js |
|
| Purpose: |
Contains variables and functions related to keyboard navigation in a slide
image page.
|
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
panel.gif |
|
| Purpose: |
An image file used to generate a topbar. |
| Location |
BluPlusPlus-->res-->topbar-->stylename ƒ |
| Notes: |
Each style has a default topbar associated with it. Screenshots
of topbars and information about how to alter the topbar
for a style is here.
|
| File name: |
photo-metadata.properties |
|
| Purpose: |
The master photo-metadata text file which defines which master
exif/iptc field names can be changed from the default in different languages.
|
| Location |
BluPlusPlus-->texts |
| Notes: |
Create a new photo-metadata_xx.properties file to create translations
of metadata field names to another language.
|
| File name: |
photo-metadata_xx.properties |
|
| Purpose: |
A language-specific file that provides translations of the terms
defined in photo-metadata.properties.
|
| Location |
BluPlusPlus-->texts |
| Notes: |
The format of these files is:
master term=target
language translation
The master terms are defined in the photo-metadata.properties file. See here for
a list of languages currently supported by BPP.
|
| File name: |
pipe.gif |
|
| Purpose: |
An image file used to generate a topbar. |
| Location |
BluPlusPlus-->res-->topbar-->stylename ƒ |
| Notes: |
Each style has a default topbar associated with it. Screenshots
of topbars and information about how to alter the topbar
for a style is here.
|
| File name: |
preview.jpg |
|
| Purpose: |
Shows a preview of a BPP album page when BPP is chosen with the skin
selection drop down menu of the
JAlbum main window. |
| Location |
BluPlusPlus |
| Notes: |
|
| File name: |
ReadMe.txt |
|
| Purpose: |
Contains basic documentation about BPP. |
| Location |
BluPlusPlus-->docs |
| Notes: |
|
| File name: |
remarks.js |
|
| Purpose: |
Contains javascript program code used to process Viewer Remarks |
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
remarks.php |
|
| Purpose: |
Contains php program code used to process Viewer Remarks |
| Location |
BluPlusPlus-->res-->php |
| Notes: |
|
| File name: |
rule.gif |
|
| Purpose: |
An image file that creates for a given style a ‘rule’ at
the top (and optionally, at the bottom) of slide image and index pages.
The ‘rule’ is a horizontal line-like element.
|
| Location |
BluPlusPlus-->res-->styles-->stylename ƒ |
| Notes: |
Not all styles have ‘rule.gif’ files associated
with them. The Arcs style is an example of a style that has a rule. A
screenshot is available
.
|
| File name: |
save-protection.js |
|
| Purpose: |
Javascript code to prevent right-clicking on images to download
them to a local disk.
|
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
setup-index.js |
|
| Purpose: |
Contains javascript variables and a pageSetup() function that are copied
into index pages when an album is generated.
|
| Location |
BluPlusPlus-->includes |
| Notes: |
This file contains dynamic code that is resolved during album
generation; the result is inserted into index pages.
|
| File name: |
setup-slide.js |
|
| Purpose: |
Contains javascript variables that are copied
into slide image pages when slide.htt is processed as an album is generated.
|
| Location |
BluPlusPlus-->includes |
| Notes: |
This file contains dynamic code that is resolved during album
generation; the result is inserted into slide image pages.
|
| File name: |
setup-slide-common.js |
|
| Purpose: |
Contains javascript variables and a pageSetup() function that
are copied into slide image pages when either slide.htt and slide-original.htt
are processed as an album is generated.
|
| Location |
BluPlusPlus-->includes |
| Notes: |
This file contains dynamic code that is resolved during album
generation; the result is inserted into slide image pages.
|
| File name: |
setup-slide-original.js |
|
| Purpose: |
Contains javascript variables that are copied
into slide image pages when slide-original.htt is processed as an album
is generated.
|
| Location |
BluPlusPlus-->includes |
| Notes: |
This file contains dynamic code that is resolved during album
generation; the result is inserted into slide image pages.
|
| File name: |
shadow.js |
|
| Purpose: |
Javascript code to create the horizontal “shadow bar” at the
bottom of each slide image and index page
|
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
slide.bsh |
|
| Purpose: |
Contains beanshell code that is executed when slide.htt is processed by
JAlbum
|
| Location |
BluPlusPlus-->bsh |
| Notes: |
|
| File name: |
slide.htt |
|
| Purpose: |
An html template plate on which slide image pages are based |
| Location |
BluPlusPlus |
| Notes: |
slide.htt (and index.htt) are basically html pages that can be edited to
further customize BPP. However, there is a great deal of beanshell code
contained in the pages, and function calls to other files (typically bsh
files), so it can be difficult to figure out exactly how to implement desired
changes. Of particular note is that much of the html generated for slide
image pages is created via ‘out.print’ commands within the beanshell
code rather than via the code of slide.htt.
|
| File name: |
slideshow.js |
|
| Purpose: |
Javascript that allows the automatic slideshow to function |
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
slide-bottom-navigation.inc |
|
| Purpose: |
creates navigation icons on the bottom of slide pages if bottom
navigation icons are specified on the BPP-General
tab
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
slide-comment.inc |
|
| Purpose: |
creates the slide comment below the image on slide image pages
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
slide-info.inc |
|
| Purpose: |
code that generates information such as name & date on slide
image pages
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
slide-original.bsh |
|
| Purpose: |
code that supports the file slide.htt |
| Location |
BluPlusPlus-->bsh |
| Notes: |
|
| File name: |
slide-original.htt |
|
| Purpose: |
An html template plate on which “full screen” slide
image pages are based
|
| Location |
BluPlusPlus |
| Notes: |
|
| File name: |
slide-photographic-meta-info.inc |
|
| Purpose: |
code that generates the EXIF/IPTC info popup box on slide
image pages
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
slide-remarks.inc |
|
| Purpose: |
creates the Viewer Remarks section of slide image pages
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
slide-top-navigation.inc |
|
| Purpose: |
creates navigation icons on the top of slide pages if top navigation
icons are specified on the BPP-General
tab
|
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
slide-topbar.inc |
|
| Purpose: |
code to create the top blue bar on slide pages |
| Location |
BluPlusPlus-->includes |
| Notes: |
|
| File name: |
statusbar.js |
|
| Purpose: |
Javascript code to support the statusbar tooltips that optionally
appear below navigation icons when the mouse is hovered over icons and
other links.
|
| Location |
BluPlusPlus-->res-->js |
| Notes: |
|
| File name: |
stylename.css |
|
| Purpose: |
css file that provides css selectors to style various parts of the generated
index and slide image pages. Also used as an empty ‘placeholder’ file
to allow JAlbum to “see” a style.
|
| Location |
BluPlusPlus-->styles and BluPlusPlus-->res-->styles |
| Notes: |
Here is more information about how styles work
in BPP.
|
| File name: |
supported-audios.txt |
|
| Purpose: |
A text file listing the audio file types support by BPP. |
| Location |
BluPlusPlus-->config |
| Notes: |
Add additional audio file types to this text file to have them supported
by BPP. |
| File name: |
supported-videos.txt |
|
| Purpose: |
A text file listing the video file types support by BPP. |
| Location |
BluPlusPlus-->config |
| Notes: |
Add additional video file types to this text file to have them supported
by BPP. |
| File name: |
texts.properties |
|
| Purpose: |
The master language text file which defines which master terms can be output
in different languages.
|
| Location |
BluPlusPlus-->texts |
| Notes: |
Create a new texts_xx.properties file to make JAlbum “speak” a
new language.
|
| File name: |
texts_xx.properties |
|
| Purpose: |
A language-specific file that provides translations of the terms defined
in texts.properties.
|
| Location |
BluPlusPlus-->texts |
| Notes: |
The format of these files is:
master term=target
language translation
The master terms are defined in the textx.properties file. See this
FAQ
for a list of languages currently supported by BPP.
Texts_xx.properties files are also used to provide specific wording
for tooltips, messages, etc. More information is here.
|
| File name: |
theme.properties |
|
| Purpose: |
A file that specifies defaults values of BluPlusPlus user variables
for a given style.
|
| Location |
BluPlusPlus-->res-->styles-->stylename ƒ |
| Notes: |
The format of these files is:
uservariable=value
More information about theme.properties files is available here.
|
| File name: |
universal ƒ |
|
| Purpose: |
Contains the icons for the icon set “universal” |
| Location |
BluPlusPlus-->res-->actions |
| Notes: |
“universal” looks best against any background, at the expense
of not being quite as subtle and detailed as the icons in “dark-matte” and “bright-matte”.
|
| File name: |
UserGuide.txt |
|
| Purpose: |
A user guide explaining the features of BPP. A much shorter version of information
available here.
|
| Location |
BluPluPlus-->docs |
| Notes: |
|
| File name: |
video-block.inc |
|
| Purpose: |
Default HTML code used to process video files in a browser. Code in
this file is used unless a filetype-specific video-block-xxx.inc
file is present. |
| Location |
BluPlusPlus-->config |
| Notes: |
By default, BPP uses the <embed> html tag to support video files.
Users may edit this file if they wish to use different code
for video files. |
| File name: |
video-block-xxx.inc |
|
| Purpose: |
HTML code used to process video files with file type ‘xxx’ in
a browser. |
| Location |
BluPlusPlus-->config |
| Notes: |
By default, BPP uses the <embed> html tag to support video files.
Users may create this file if they wish to use different code
for a specific video file type. |
| File name: |
white ƒ |
|
| Purpose: |
Contains the icons for the icon set “white” |
| Location |
BluPlusPlus-->res-->actions |
| Notes: |
“black” looks best against a dark background |
|
