- Generated by
1.14.0
|
Standalone Hypergrid Open Simulator BRIGADOON-0008
Configuration of Little-Sense OPen Simulator instance
|
The table below shows the parameters that can be inserted into a file and replaced when the documentation is processed.
In addition to these fixed parameters, user parameters can also be defined for substitutions. Each of the parameters below is encased by lead-in ' [# ' and lead-out ' #] ' characters to indicate that a substitution should occur.
| PARAMETER | Parameter Meaning | Example |
|---|---|---|
| ASSISTANCE_WELCOME | Assistance Welcome Flag. | ASSISTANCE_WELCOME |
| ASSOC_FULL_NAME | Full Name of Project's Associatied Group. | Royal Flying Test People |
| ASSOC_LOGO | Associationed Group's Logo. | association.png |
| ASSOC_SHORT_NAME | Short Name of Project's Associatied Group. | RFTP |
| ASSOC_URL | Associatied Group's URL. | http://www.assoc.au/index.html |
| BRIEF_DESC | Brief Description of the Project. | One sentence description |
| CAVEAT_LECTOR | Caveat Lector (Reader Beware) Flag. | true |
| CODE_DIR | Project's Code Directory. | /code/ |
| COMPILER_FULL_NAME | Compiler Family Full Name. | General C/C++ Language Programming |
| COMPILER_IMAGE | <Compiler Family Image. | C++.png |
| COMPILER_SHORT_NAME | Compiler Family Short Name. | C++ |
| CONTROL_DOC_ACCESS | Control Document Access Flag. | CONTROL_DOC_ACCESS |
| COPYRIGHT_STATEMENT | Copyright Statement | Copyright © 2019-2024 by Brigadoon |
| CPPCHECK_RESULTS | Results from CPP Check Analysis | Nothing found |
| DEPARTURE_URL | Departure URL. | http://www.little.id.id/some/where.html |
| DEV_FULL_NAME | Development Family Full Name. | Documentation (Project and General) |
| DEV_IMAGE | Development Family Image. | doc_project.png |
| DEV_SHORT_NAME | Development Family Short Name. | Documentation |
| DEVELOPER_EMAIL | Developer's Email. | river.nosp@m.-pir.nosp@m.ate@a.nosp@m.ussi.nosp@m.ebroa.nosp@m.dban.nosp@m.d.com.nosp@m..au |
| DEVELOPER_HANDLE | Deveoper's Handle. | RiverPirate |
| DEVELOPER_INFO | Developer's Information. | Backgroup Information. |
| DEVELOPER_NAME | Developer's Name. | Mark Little |
| DEVELOPER_PHONE | Developer's Phone Number. | 0XXXXXXX517 |
| DIA_PATH | Directory hold the Project's DIA Files. | /usr/bin/ |
| DL_FULL_NAME | Documentation Licence Long Name. | Creative Commons Attribution Share Alike 4.0 International |
| DL_IMAGE | Documentation Licence Image. | CC-BY-SA-4.0.png |
| DL_SHORT_NAME | Documentation Licence Short Name. | CC-BY-SA-4.0 |
| DL_URL | Documentation Licence's URL. | https://spdx.org/licenses/CC-BY-SA-4.0.html |
| DOCUMENTATION_ADDRESS | Project's Documentation Directory. | /docs/ |
| DONATIONS_WELCOME | Donations Welcome Flag. | true |
| DOT_IMAGE | DOT Image File Directory. | /dot/images/ |
| DOXY_FILTERS | Pointer to Doxyen Filters. | /doxy/filters |
| DOXY_FOOTER | Doxygen Footer File. | doxy_footer.txt |
| DOXY_HEADER | Doxygen Header File. | doxy_header.txt |
| DOXY_IMAGE_PATH | DOxgen Image File Path. | /images/ |
| DOXY_LOG_FILE | Dxygen's Log File. | /scratch/doxy_log_file.txt |
| DOXY_LOGO | Doxygen's Logo. | doxy_logo.png |
| DOXY_RESULTS | Error Listing from Doxygen | Include file not found |
| DOXY_STYLESHEET | Doxygen Stylesheet. | doxy_stylesheet.txt |
| DOXY_TAB_SIZE | Doxygen Tab Size. | 4 |
| ENABLE_CUSTOM_DOXY | Enable Custom Doxy Parameters Flag. | false |
| EXCLUDE_FROM_LIST | Exclude Project from List Flag. | false |
| EXE_BUILD_DIR | Directory Where Program is Built. | /home/test/Projects/BRIGADOON-0002/source/netprojman/ |
| EXE_NAME | Executable's Name. | netprojman |
| EXECUTABLE_DIR | Executable's Directory | /build/directory |
| FULL_DESC | Full description of the Project. | Multi-line description of program's functions |
| GROUP_ACCESS_ONLY | Associated Group's Access Only Flag. | false |
| HL_FULL_NAME | Hardware Licence Full Name. | TAPR Open Hardware License v1.0 |
| HL_IMAGE | Hardware Licence IMage. | TAPR-OHL-1.0.png |
| HL_SHORT_NAME | Hardware Short Licence Name. | TAPR-OHL-1.0 |
| HL_URL | Hardware Licence's URL. | https://spdx.org/licenses/TAPR-OHL-1.0.html |
| INTERACTIVE_SVG | Intractive SVG Flag. | INTERACTIVE_SVG |
| LEAD_IN | Show Lead-In characters, without substitution | Lead-In Sequence |
| LEAD_OUT | Show Lead-Out characters, without substitution | Lead-Out Sequecnce |
| LOCAL_DEV_DIR | Local Development Disk Directory. | /home/test/Projects/ |
| OFFER_PAYPAL_DONATION | Offer PayPal Facility Flag. | false |
| ONLY_DEFAULT_PAGE | Show Only Default Page Flag. | false |
| OPTIMIZE_C | Optimise Doxygen for C/C++ file. | YES |
| OPTIMIZE_FORTRAN | Optimise Doxygen for Fortran | YES |
| OPTIMIZE_JAVA | Optimise Doxygen for Java. | YES |
| OPTIMIZE_VDHL | Optimize Doxygen for VDHL | YES |
| POTENTIAL_HAZARD | Potential Hazard Warning Flag. | false |
| PROJECT_ICON | Project Icon. | netprojman.png |
| PROJECT_IDENT | Project Identification Number. | BRIGOON-0002 |
| PROJECT_NAME | The Name of the Project. | netprojman |
| POTENTIAL_HAZARD | Potential Hazard Flag | true |
| PUBLISHER_CONTACT | Publisher's Contact. | info@.nosp@m.mail.nosp@m..somw.nosp@m.here.nosp@m..au |
| PUBLISHER_WEBSITE | Publisher's Website Address. | http://www.publisher.org.au |
| SITE_LOGO | Development Site's Logo. | brigadoon.bmp |
| SITE_NAME |
<Development> Site's Name.
Brigadoon
SITE_URL
Development Site's URL.
SL_IMAGE
Software Licence Image.
GPL-3.0-or-later.png
SL_FULL_NAME
Software Licence Full Name.
GNU General Public License v3.0 or later
SL_SHORT_NAME
Software Licence Short Name.
GPL-3.0-or-later
SL_URL
Software Licence's URL.
https://spdx.org/licenses/GPL-3.0-or-later.html
SOURCE_LIST
List of software source files.
main.c, main.h, extra.hpp
STATUS_DATE
Status Date.
2024-12-32 18:00:00
STATUS_DESC
Status Level Description.
The project has been released for general use after testing was completed.
STATUS_IMAGE
Status Level Image.
released.png
STATUS_NAME
Status Level Name.
Released
TEMPLATE_DIR
Template's Disk Directory.
/var/local/share/brigadoon/netprojman/
TOOL_DIRECTORY
Development Tool Directory.
TOOL_IMAGE
Development Tool Image.
qt.png
TOOL_FULL_NAME
Development Tool Full Name.
Qt IDE
TOOL_SHORT_NAME
Development Tool Short Name.
Qt Creator
VERSION
Project Version.
1.1.0
VERSION_DATE
Date of the Version Number.
2024-12-32 18:00:00
VERSION_TEXT
Description of the Version.
Initial working version.
VERSION_HISTORY
Version History.
All the version history.
WEB_DIR
Project's Website Directory.
/mnt/server/var/www/projects/
WEBSITE_DIR
Website's Disk Directory.
/mnt/website/var/projects/
WEBDIR_PROJECT_DOCS
The disk directory holding the project's docs directory
/var/www/docs
WEBDIR_PROJECT_HTML
The disk directory holding the Project's HTML Directory
/var/www/html
WEBDIR_PROJECT_IMAGES
The disk directory holding the project's images directory
/var/www/images
WEBSITE_PROJECT_DOCS
The URL pointing to the Project's Docs directory
https://www.the_site.au/project_dynamic/docs
WEBSITE_PROJECT_HTML
The URL pointing to the Project's HTML directory
https://www.the_site.au/project_dynamic/
WEBSITE_PROJECT_IMAGES
The URL pointing to the Project's Images directory
1.14.0