Added example configuration file

Added an example .ini-like configuration file, required by SWG.
This commit is contained in:
luca0N! 2022-03-02 18:39:37 -03:00
parent 4c47a02f61
commit b0f1b66956
Signed by: luca0N
GPG Key ID: 2E7B4655CF16D7D6
1 changed files with 76 additions and 0 deletions

76
swg.example.cfg Normal file
View File

@ -0,0 +1,76 @@
# SWG Context Configuration File
# <https://git.luca0n.com/swg.git>
# This is a very minimal .ini-like configuration file.
#
# Comments are allowed at the beginning of a new line starting with the '#'
# character.
[General]
# General website configuration.
# This is the name of the website, which will be used to display in page
# headers as well as in the HTML title of pages.
WebsiteName="My Website"
# This specifies the website publisher.
WebsitePublisher="John Doe"
# Copyright
#
# Now we'll define a couple of copyright-related options which will be used to
# generate copyright disclaimer text shown in the footer of all pages.
# WebsiteCopyrightHolder specifies the copyright holder of the content
# published on the website. Multiple copyright holders can be specified here.
# If this value is set to "N/A", SWG will not show the copyright holder. You
# should specify the copyright holder here if you're not using a non-public
# domain license.
WebsiteCopyrightHolder="N/A"
# This defines the copyright year or copyright years of the published content.
# You shoiuld specify this even if your website content is in the public domain.
#
# Example values:
# - 2019-2022
# - 1965-1970, 2000-2005, 2008, 2012-2022
# - 2020, 2022
# - 2022
WebsiteCopyrightYears="2022"
# This defines the license of the published content. If SWG detects a public
# domain license, a different copyright disclaimer will be shown. Use
# "AllRightsReserved," "PublicDomain," or a SPDX license identifier. A "unless
# otherwise stated" disclaimer will also be shown on the copyright notice, so
# you should specify the general default license here while manually specifying
# other licenses where applicable.
#
# WARNING: keep in mind that by using a public domain license, you waive your
# rights, so you can't change the license later!
#
# SPDX license list: <https://spdx.org/licenses/>.
#
# Example values:
# - AllRightsReserved
# - PublicDomain
# - CC0 # Creative Commons public domain
# - CC-BY-SA-4.0 # Creative Commons Attribution-ShareAlike 4.0 Generic
# - GFDL-1.3-only # GNU Free Documentation License (version 1.3 only)
WebsiteContentLicense="CC0"
[Blogs]
# Multiple blog areas are allowed here.
# Start with Blog1<Name|Path>, and then increase the number '1' to add another
# blog.
#
# BlogNPath specifies the path (relative to this directory) containing articles that belong to this blog.
# BlogNName specifies the name of the current blog.
# BlogNDir specifies the name of the subdirectory that will store all articles for that specific blog.
#Blog1Path="./blog/personal/"
#Blog1Name="My Personal Blog"
#Blog1Dir="personal"
#Blog2Path="./blog/announcements/"
#Blog2Name="My Announcements Blog"
#Blog2Dir="announcements"
#...