diff options
author | sternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org> | 2020-08-24 19:20:23 +0200 |
---|---|---|
committer | sternenseemann <0rpkxez4ksa01gb3typccl0i@systemli.org> | 2020-08-24 19:20:23 +0200 |
commit | 342c550fa7243398fa6b580d7f8393f5029e42c0 (patch) | |
tree | 7e56fdd22e733cd6808ac7365d1c9e630419bb22 | |
parent | d87520f6a1cdb31526a4370bb06bb7cf7a993a35 (diff) |
refactor(config.example.h): restructure
-rw-r--r-- | config.example.h | 36 |
1 files changed, 20 insertions, 16 deletions
diff --git a/config.example.h b/config.example.h index 6b9a5ae..2cd3ac3 100644 --- a/config.example.h +++ b/config.example.h @@ -4,7 +4,7 @@ */ /*! - * @name General Settings + * @name Operational Settings * @{ */ @@ -18,19 +18,27 @@ #define BLOG_DIR "/srv/sternenblog/" /*! - * @brief Site title + * @brief Public URL of the webserver * - * Title of the site to serve. - * Will be used for the RSS feed and in templates to, e. g. set the HTML title tag. + * (External) URL the server that the script is running on is reachable via. + * This should be the base URL of your webserver without any trailing slashes + * or subpaths, as sternenblog will use SCRIPT_NAME and PATH_INFO to figure + * out the path from the root of the server. */ -#define BLOG_TITLE "sternenblog" +#define BLOG_SERVER_URL "http://localhost" //! @} /*! - * @name RSS Settings + * @name Site Metadata * @{ + * @brief Site title + * + * Title of the site to serve. + * Will be used for the feeds and in templates to, e. g. set the HTML title tag. */ +#define BLOG_TITLE "sternenblog" + /*! * @brief Site description * @@ -41,17 +49,11 @@ */ #define BLOG_DESCRIPTION "my personal blog" -/*! - * @brief Public URL of the webserver - * - * (External) URL the server that the script is running on is reachable via. - * This should be the base URL of your webserver without any trailing slashes - * or subpaths, as sternenblog will use SCRIPT_NAME and PATH_INFO to figure - * out the path from the root of the server. - */ -#define BLOG_SERVER_URL "http://localhost" +//! @} /*! + * @name Caching + * @{ * @brief TTL of RSS feed * * TTL (time to live) of the RSS feed in minutes. Feed readers may use this @@ -64,7 +66,7 @@ //! @} /*! - * @name Optional Settings (delete to unset) + * @name Template settings * @{ */ /*! @@ -72,6 +74,8 @@ * * CSS Stylesheet to use for the entire site. The default template will use * the Stylesheet URL given here if present. + * + * Optional setting. */ #define BLOG_CSS "/sternenblog.css" //! @} |