JAlbum/Where are my files
| Contents |
|---|
Introduction
This page shows you the folders and files jAlbum uses both for your projects and for any skins or add-ons you install. There are, if you use jAlbum's defaults, in two directories that contain user files, they are My albums (your projects) and the Configuration (skins, external tools, plugins and default settings). If you want to backup or migrate your jAlbum files you need to copy those two directories to your backup/new computer, and if the project uses links the original files. If installing on a new computer get jAlbum application from here
Moving jAlbum to a new computer
See Moving jAlbum to a new computer
My albums
jAlbum's default location for your projects is a folder called 'My Albums' within your 'home' folder. This location can be checked, or changed, by going to Menu/jAlbum/Preferences/Album (for other operating systems it is Menu/Tools/Preferences). Look for the 'My albums' location, the path to the folder is displayed and can be changed by clicking on the small folder icon to the right of the path. Each of your projects will, unless you change it, under Settings/General, be contained within subfolders of that folder. If you want to backup all of your projects or copy/migrate them to a new computer then this is the folder to go to. Each of your project folders will be named the same as the project's name.
When you create a new project the default location for the output album is a subfolder of the project folder, called 'album'. You can change this location for each album or for all future albums by selecting a new output folder in Settings/General and then using Menu/File/Save as default. There is a preference setting that allows you to change the output location for all new projects.
From any open project you can use the keyboard shortcut Cmd/Ctrl + I + SHIFT to open the image directory. My albums directory is one level up/back from there. If you have any projects stored outside of the My albums folder it might be worth checking the recent-projects.txt file in the config directory for such stray albums or search your computer for '.jap' files.
Anatomy of a project
The files in a project cannot be directly shared with another project without changes affecting both projects, for this reason projects should be considered as unique entities. If you want to use images in more than one project use the link>mirror method, so your are isolated from the files being used. The same restriction applies to having multiple settings files applied to a single set of files.
Each jAlbum project is made up of files and folders that you add and also those that jAlbum creates. The 'Sample Portfolio' project, copied to your’My Albums’ folder, supplied with jAlbum (Menu/Tools/Open directories/Program to open jAlbum's installation directory and then navigate to samples/Sample Portfolio) is a typical project. We will use that project to look at how jAlbum does its magic.
Invisible Items
There are hidden folders at the each level (folders within, of the project) called '.jalbum' and contains a cache folder, which may have thumbnail images, jAlbum control & Information files such as albumfiles.txt, comments.properties, meta.properties and XML .info files such as About.htt.info, Contact.htt.info (for these .htt template files the .info files contain the data entered in the template’s fields), res.info and an audioClips folder. The cache folder is used to speed up previewing of thumbnails, its contents are generated as needed. The .info files store information for each file or folder on settings, like cropping, filters, variables, theme images and key events such as when the album was last made etc. The audioClips folder only exists if audio clips have been attached to an object, there will be a an audio file for each object that has a clip attached. The object's .info file stores the data on the clip. In addition some skins and external tools will place files within the .jalbum folder, either directly or in a subfolder named after the skin or tool.
If you want to see these files then you can either set your OS to show invisible files or use a text application that can access invisible files. In Mac OS use the keyboard shortcut SHIFT + COMMAND + period to toggle visibility, in Windows use the file explorer to change visibility. Warning, don't change anything unless you know exactly what you are doing! Even so, it is not recommended to manually change any of these files.
Let's start with the project's root folder, what you see in jAlbum if you load the project. Once a project is shown in jAlbum's explore view you can see the project folder on your computer by using SHIFT+Cmd/Cntr+I keyboard shortcut. These are the files and folders that can be seen there:
About.htt album Bokeh.jpg Contact.htt jalbum-settings.jap (the settings can be saved with a different filename, it will still end with .jap) Nature Objects People res Travel
Note, albumfiles.txt, comments.properties and meta.properties are in a hidden .jalbum folder
User Files & Folders
The folders for People, Nature, Objects and Travel contain the images that are to be shown in the album. The Bokeh.jpg image, with a circle and bar, has been excluded so it won't show as a normal part of the album. About.htt & Contact.htt are 'page templates' that are supplied with the skin being used, in this case Turtle. As you can guess from their names they are designed to show information about the album and its creator.
There can be a semi-transparent folder called 'res'. When you add a folder called 'res' jAlbum will convert it to a special type of folder. It is 'hidden' but not excluded, so no links are created to it but all of its contents are copied to the album's 'res' folder. However, unsupported file types, like JavaScript need to be added in your OS finder/browser as jAlbum will not allow drag and drop of such files. As an example, the Sample Portfolio project's 'res' folder contains a 'dummy.jpg' image which is used as a placeholder for the About.htt template's author's image.
Files not found in the Sample Portfolio project, but allowed are;
filename.thm this is a jpeg image with its file extension changed to ‘thm’. It is used to provide an alternative thumbnail for files, for example ‘Instructions.PDF’ could have an image named ‘Instructions.thm’. In both jAlbum’s explore view and the album, the PDF’s thumbnail would be that image, instead of a generic PDF icon.
filename.text is used by some skins as an addition, or alternative, source for the comment text. As above, replace filename with the name of the file you want to use the text with.
Many skins have a res folder that is copied to the album even if the project does not include one. Adding a res folder to the root of your project lets you replace skin res files with your own, as the skin res folder is copied to the album first. For example adding your own wait.gif image would replace the skin's wait.gif file. This allows some degree of customisation of the skin without having to actually modify it, with the added bonus that the modification will survive skin updates.
The Album
The folder named 'album' is the output folder created by jAlbum when you 'make album' and it contains all of the files required for your web album to work. This includes a 'res' folder, it contains files and folders that that come from the skin, such as the icons and CSS style sheets that define the 'look' of your album. This folder is what needs to be uploaded to your website for visitors to be able to see it.
jAlbum control & Information files
The following files are all plain text files which can be examined with any text editor. If you look at these files note that a # is used before a comment, it is ignored by jAlbum; a \ character is an 'escape' character and is commonly used to make multi-line entries appear as a single line; the = character is used to pair a 'key' to some 'property' associated with it, like a comment for an image or a skin setting.
albumfiles.txt
It stores information about the user files and folders added to the project. Below is the contents of the root folder's albumfiles.txt file.
# This file is created by JAlbum. It sets custom file filtering and ordering for this image directory. # Files not listed here are added to the end of the album # Rows beginning with "-" indicate excluded files. # Rows can have up to 3 tab separated columns according to this scheme: # File name | Target path (for links) | When added (seconds since epoch) | Original/Camera date # Note: The target path can reference files and directories in other locations and thereby # allows you to compile albums consisting of files from several different locations. People 1373019265 Nature 1373019265 Objects 1373019265 Travel 1373019265 -Bokeh.jpg 1382915383 1276524431 About.htt 1382915383 Contact.htt 1383053551 res 1383307026
EPOCH: in this case the epoch date is 1 January 1970 00:00:00, known as the UNIX epoch or POSIX time.
comments.properties
Stores all comments you enter into the jAlbum comments field as shown in explore and edit view modes. For the Sample Portfolio only three files have comments, they are About.htt, Contact.htt and Bokeh.jpg. The comments.properties file contains:
About.htt=You can add custom made pages like this one to your album projects.\ Right click an empty space between two thumbnails and select "New page" to create a new page.\ Right click this page's thumbnail and select "Edit" to edit the source code. Contact.htt=You can add custom made pages like this one to your album projects.\ Right click an empty space between two thumbnails and select "New page" to create a new page.\ Right click this page's thumbnail and select "Edit" to edit the source code. Bokeh.jpg=<h2>Good to know!</h2>\ <p>Click "Make album" to make a full blown portfolio site out of this sample project.</p><br/>\ <p>You can include all kinds of files (images, videos, docs...)</p><br/><p>New pages are added by right clicking on the white area between thumbnails and choosing "New page".</p>\ Good luck!
jalbum-settings.jap
This file stores all of the settings used when you last saved the album (Menu/File/Save project or 'made' the album and 'save project on make album' is checked in preferences). 'jalbum-settings' is the default file name but it can be saved with an alternative name. If the project has been saved with a name other than 'jalbum-settings' the project will appear in the recent projects list under the name of the settings file.
These files are long, due to the number of jAlbum and skin settings possible. An example of the contents of the project file is shown below:
#jAlbum Project #Fri Oct 28 23:19:00 BST 2016 cpuCores=8 style=Linen.css directory=/Applications/jAlbum.app/Contents/Java/samples/Sample Portfolio outputDirectory=album updatedDirsOnly=false rows=999 imageSize=900x600 skin=Turtle skin.fontSize=13px skin.textColor=\#bbbbbb
Skin settings are prefixed with skin. while jAlbum settings have no prefix, such as outputDirectory. Since # normally indicates a comment it has to be escaped with a \.
meta.properties
Tracks information about each folder, such as how files are ordered and the image to be used for its thumbnail. The contents of the meta.properties file is:
ordering=custom folderIcon=Nature descript=Portfolio template album using dummy images
You can read more on how jAlbum uses all of these files here
Extensions, Enhancements & Defaults
You can enhance and extend jAlbum in various ways, such as external tools, plug-ins and additional skins. The location of those additional files and your default settings is within the jAlbum configuration folder, you can find this by using Menu/Tools/Open directories/Configuration directory or keyboard shortcut SHIFT+CMD/CTR+C
accounts.xml
If you have used jAlbum's FTP to upload files then this file stores those FTP settings.
bin
This folder contains things like ffmpeg, used to convert videos to mp4 format, which you might have installed or updated.
defaults.jap
This file contains settings for jAlbum and the default skin when jAlbum starts, see Save as default
dictionaries
This folder will contain any user entered words for the built-in spell checker, see Preferences>General>Highlight misspelled word, the folder is empty until a custom word has been added. The dictionaries will be named UserDictionary_en.txt, where 'en' means an English language dictionary and 'de' would be a German dictionary.
SkinName-defaults.jap
From jAlbum 15.1 each skin can have its own default settings, for example Tiger skin would have Tiger-defaults.jap. When invoked by Save as Skin Default the currently applied skin settings will be saved for use when the skin is loaded for new projects. To use the skin's suggested default settings instead hold down the 'ALT' key when loading the skin. To revert to the skin's suggested defaults for all future projects use the 'reset' button on the skin 'information' window, this will delete the skin's default jap file.
ext
This folder contains addition extension files, .jaext, which add extra funcionality to jAlbum.
recent-projects.txt
The recent projects shown in jAlbum's explore view are read from this file.
skins
jAlbum comes with several skins but if you install additional skins, or update bundled skins, then they go here. Skins bundled with jAlbum appear in regular weight font and skins installed by the user appear in bold. A bundled skin however will appear in bold once it has been updated, as updates go in to the user's skins directory, not the program directory. It is important to note that any custom skin will be in this location only.
system
This folder currently supports a single file called filetypes.xml. You can use this file to add support for custom file types and those file types will survive an update of the application. The file's content would be something like this
<?xml version="1.0"?> <!-- Custom file types that JAlbum is to recognize --> <filetypes> <type name="WOFF file" icon="unknown.png"> <ext>woff</ext> </type> <type name="CSV text" icon="my custom.png"> <ext>csv</ext> </type> </filetypes>
themes
An optional directory that can be added to support additional look & feel 'Flat' themes. This is where you add the additional Flat theme's JSON file. See Preference>General>Look & Feel for further information.
tools
Any additional external tools, .bsh files, installed from the forums, or written by yourself will be installed here.
Lifeboat file
jAlbum has a built in method of backing up your projects to the cloud, see Play safe with jAlbum and Preferences > Album > Include the lifeboat file. There is also an enhanced version that will include a copy of the skin used, handy if you have made custom changes, which is here. The lifeboat file is a snapshot of your project at the time it is used, if you change any settings or edit any comments etc. You should update the lifeboat file.
Note The lifeboat is a preference setting, in Preferences/Album
Other files
Other files that are used by jAlbum.
Manifest file
If you use jAlbum's FTP uploader you will find a manifest.jmf file in the root directory of your uploaded album. It is used by jAlbum to speed up uploading, by only loading updated or new files. jAlbum 'knows' about files it uploaded, so if you delete a file within jAlbum it will delete it from the server too. If you change skins for a project it will also delete those now unused files that were specific to the old skin.
Conversely, unwanted files on the server that have been uploaded without jAlbum's uploader will not be deleted, as jAlbum can't know if they are needed or not.
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License