Skip to content

Software Pages Front Matter

Peter Johnson edited this page Sep 30, 2021 · 2 revisions

This page lists the front matter used on pages in the software collection. This collection covers two different types of software: applications and source code library.

Each type of software has slightly different data associated with it and slightly different page layouts, each with some common and some unique front matter.

Common Front Matter

Identifier Remarks
id Identifier of the software items. Unique within the collection.
layout Identifies the layout to use for this item. Valid values are codelib-tpltand program-tplt.
group Identifies the group to which the software item belongs. Valid values are lib and apps
priority Indicates the importance of the software item within its group. Determines order of appearance on the page that lists the software items. Must be a digit and unique within the group.
version Version of last release in form 9.9.9.
release-date Date of last release in form YYYY/MM/DD.
title Name of software item as it appears in page title.
precis A precis of the purpose of the software item as it appears in page strap line.
summary Brief summary of the purpose of the software as it appears on the page that lists the software items.
download-base-url URL from where the file can be downloaded. For applications this will have the version number appended to it. For library items this is the complete URL.
repo-name Name of the provider of the repository where the source code is under version control. Valid values are SourceForge and GitHub
repo-url URL of the repository where the source code can be found. For applications this is the actual repo name but for code library items it represents the sub directory of the code library repo where the particular library project is located.
want-header-buttons Boolean value indicating if the page header should display download and repository link buttons.
status Status the software item. Permissable values are: current - currently under development, mothballed - no longer developed or obsolete - no longer developed and obsolete (should not be used).

Front Matter Unique To Applications

Identifier Remarks
os Operating system requirements for the application.

Front Matter Unique To Code Library Projects

Identifier Remarks
dl-file-prefix First part of the name of the download zip file. This prefix is followed by the version number and .zip
platforms Array of platforms at which the project can be targeted. Valid values are one or more of Win32 and Win64
frameworks Array of frameworks that the project is compatible with. Valid values are one or more of VCL, FMX, RTL and IDE.
compatibility Versions of Delphi with which the library project will compile.