Directory Listing
This paragraph allows you to display links to your folders and files on the downloads.jboss.org server. For each file, the size, last modification date, and checksums (MD5 and SHA1) are displayed. It's also possible to display a description for each file and folder in addition to displaying a permanent link to the latest download for quick reference.
This paragraph also optionally generates a pop-up warning dialog. By default this informs the user that the download is from a community project and therefore not supported by Red Hat. They are then given the option to continue the download or cancel it.
An Example: SwitchYard Downloads
| Name | Modified | Size | Description | |
|---|---|---|---|---|
| v0.1 | ||||
| v0.2 | ||||
| v0.3 | ||||
| v0.3.CR1 | ||||
| v0.4.CR1 | ||||
| v0.4.Final | ||||
| v0.5.Beta1 | ||||
| v0.5.Final | ||||
| v0.6.Beta1 | ||||
| v0.6.Beta2 | ||||
| v0.6.Final | ||||
| v0.7.Final | ||||
| v0.8.Final | ||||
| v1.0.Final | ||||
| v1.1.Final | ||||
| v2.0.Alpha1 | ||||
| v2.0.Alpha2 | ||||
| v2.0.Alpha3 | ||||
| v2.0.Beta1 | ||||
| v2.0.CR1 | ||||
| v2.0.Final | ||||
| v2.1.Final | ||||
The configuration dialog is very straightforward:
You can only choose the paragraph title, the project root path, and alternatively uncheck the checkbox for displaying the Download Confirmation dialog or change the text of the Download Confirmation (see the description at the end of the Download Table paragraph description).
The project root is the main folder containing your files on the downloads.jboss.org server:
Note: If your project files are not hosted at downloads.jboss.org, you cannot use this paragraph. For instruction how to migrate your files there, contact the JBoss Community Team.
Adding extra information
In addition to listing folders and files you can also specify a permanent link to the latest download, display extra information about the current folder being viewed or provide descriptions for individual files. This is done using meta-data files which are placed into the directory structure of your project as follows:
lastRelease.properties
This file must be placed in the project root folder and can contain only one property named lastRelease:
lastRelease=http://downloads.jboss.org/modeshape/2.7.0.Final/modeshape-2.7.0.Final-dist.zip
This causes a statement of the form "Looking for the latest version? Download modeshape-2.7.0.Final-dist.zip." to be displayed at the top of the paragraph so users can easily find the latest download regardless of which folder they're viewing. The value of the lastRelease property will be the link target.
mgnl.folder.readme
This file can be added to any folder to give a description of the folder's contents above the table when a user views it. It can contain any HTML so it is your responsibility to not break the page design.
mgnl.files.properties
This file can be also added to any folder in order to give descriptions for the files within in. The names of the properties are the names of the files in the folder and the values are HTML snippets to be placed into the Description column of the file list table:
modeshape-2.7.0.Final-all-with-dependencies.jar=JAR of JARs
modeshape-2.7.0.Final-client.jar=Self-contained JDBC driver and RESTful client library
modeshape-2.7.0.Final-dist.zip=Source and binaries
As with the mgnl.folder.readme file it is your responsibility to not break the page design.