qsgen2(1)
=========
:compat-mode!:

NAME
----
qsgen2 - a shell script

SYNOPSIS
--------
Documentation automatically generated with `zsdoc'

FUNCTIONS
---------

 _add_blog_list_to_index
 _blog_cache
 _blog_idx_for_index
 _blog_index
 _blogs
 _cleanup
 _file_to_lower
 _f_last_updated
 _help
 _image
 _last_updated
 _link
 _list_blogs
 _list_pages
 _msg
 _pages
 _pages_cache
 _p_qstags
 _qstags
 _run_engine
 _sitemap
 _version
 _youtube

DETAILS
-------

Script Body
~~~~~~~~~~~

Has 101 line(s). Calls functions:

 Script-Body
 |-- _blogs
 |   |-- _blog_cache
 |   |   `-- _list_blogs
 |   |       `-- _msg
 |   |-- _blog_idx_for_index
 |   |   `-- _msg
 |   |-- _blog_index
 |   |   |-- _f_last_updated
 |   |   |   `-- _msg
 |   |   `-- _msg
 |   |-- _list_blogs
 |   |   `-- _msg
 |   `-- _msg
 |-- _help
 |-- _msg
 |-- _pages
 |   |-- _add_blog_list_to_index
 |   |-- _msg
 |   `-- _pages_cache
 |       `-- _list_pages
 |           `-- _msg
 |-- _sitemap
 |   `-- _msg
 `-- _version
     `-- _msg

Uses feature(s): _autoload_, _export_, _source_, _zmodload_

_Exports (environment):_ blogdate [big]*//* file_ext [big]*//* sitemap_force [big]*//* today

_add_blog_list_to_index
~~~~~~~~~~~~~~~~~~~~~~~

____
 ## 
 # @brief Add the blog list to the index file if blog_in_index is true.
____

Has 9 line(s). Doesn't call other functions.

Called by:

 _pages

_blog_cache
~~~~~~~~~~~

____
 ## 
 # @brief Cache the state of blog files and identify changes.
____

Has 31 line(s). Calls functions:

 _blog_cache
 `-- _list_blogs
     `-- _msg

Called by:

 _blogs

_blog_idx_for_index
~~~~~~~~~~~~~~~~~~~

____
 ## 
 # @brief Generate the file blog/index.tmp.html.
____

Has 59 line(s). Calls functions:

 _blog_idx_for_index
 `-- _msg

Called by:

 _blogs

_Environment variables used:_ BLOG_META_STR_ARRAY

_blog_index
~~~~~~~~~~~

____
 ## 
 # @brief Generate the www_root/blog/index.html file.
____

Has 30 line(s). Calls functions:

 _blog_index
 |-- _f_last_updated
 |   `-- _msg
 `-- _msg

Called by:

 _blogs

_Environment variables used:_ new_updated_blogs

_blogs
~~~~~~

____
 ## 
 # @brief Generate or update blog files or export metadata based on argument.
____

Has 155 line(s). Calls functions:

 _blogs
 |-- _blog_cache
 |   `-- _list_blogs
 |       `-- _msg
 |-- _blog_idx_for_index
 |   `-- _msg
 |-- _blog_index
 |   |-- _f_last_updated
 |   |   `-- _msg
 |   `-- _msg
 |-- _list_blogs
 |   `-- _msg
 `-- _msg

Uses feature(s): _export_

Called by:

 Script-Body

_List of exports (to environment):_ BLOG_META_STR_ARRAY [big]*//* new_updated_blogs

_Environment variables used:_ new_updated_blogs [big]*//* no_blogs_found

_cleanup
~~~~~~~~

____
 ## 
 # @brief Remove leftover tags from the content.
 # @param content The content to be cleaned.
 # @return The cleaned content.
____

Has 16 line(s). Doesn't call other functions.

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

_file_to_lower
~~~~~~~~~~~~~~

____
 ## 
 # @brief Convert the filename to lowercase and replace spaces with dashes.
 # @param filename The original filename.
 # @return The modified filename.
____

Has 5 line(s). Doesn't call other functions.

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

_f_last_updated
~~~~~~~~~~~~~~~

____
 ## 
 # @brief Update #updated and #version tags in the provided file.
 # @param file_path The path to the file to be updated.
____

Has 19 line(s). Calls functions:

 _f_last_updated
 `-- _msg

Called by:

 _blog_index

_Environment variables used:_ today

_help
~~~~~

____
 ## 
 # @brief Display help information for the script.
 # @param ... Additional arguments (unused in this function).
____

Has 2 line(s). Doesn't call other functions.

Called by:

 Script-Body

_image
~~~~~~

____
 ## 
 # @brief Convert #showimg tags to HTML img tags.
 # @param content The content containing #showimg tags.
 # @return The content with #showimg tags replaced by HTML img tags.
____

Has 28 line(s). Doesn't call other functions.

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

_last_updated
~~~~~~~~~~~~~

____
 ## 
 # @brief Update #updated and #version tags in the provided content.
 # @param content The content to be updated.
 # @return The updated content.
____

Has 15 line(s). Calls functions:

 _last_updated
 `-- _msg

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

_Environment variables used:_ today

_link
~~~~~

____
 ## 
 # @brief Convert #link tags to clickable HTML links.
 # @param content The content containing #link tags.
 # @return The content with #link tags replaced by HTML links.
____

Has 27 line(s). Doesn't call other functions.

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

_list_blogs
~~~~~~~~~~~

____
 ## 
 # @brief List all blog files and store them in an array.
____

Has 22 line(s). Calls functions:

 _list_blogs
 `-- _msg

Uses feature(s): _export_, _setopt_

Called by:

 _blog_cache
 _blogs

_List of exports (to environment):_ no_blogs_found

_list_pages
~~~~~~~~~~~

____
 ## 
 # @brief List all page files and store them in an array.
____

Has 21 line(s). Calls functions:

 _list_pages
 `-- _msg

Uses feature(s): _export_, _setopt_

Called by:

 _pages_cache

_List of exports (to environment):_ no_pages_found

_Environment variables used:_ file_ext

_msg
~~~~

____
 ## 
 # @brief Display a message with specific formatting based on message type.
 # @param type The type of message (e.g., std, info, debug, etc.)
 # @param ... The keys or additional strings to be formatted and displayed.
____

Has 21 line(s). Doesn't call other functions.

Called by:

 _blog_idx_for_index
 _blog_index
 _blogs
 _f_last_updated
 _last_updated
 _list_blogs
 _list_pages
 _pages
 _p_qstags
 _qstags
 _run_engine
 Script-Body
 _sitemap
 _version

_pages
~~~~~~

____
 ## 
 # @brief Generate all new and updated pages.
____

Has 108 line(s). Calls functions:

 _pages
 |-- _add_blog_list_to_index
 |-- _msg
 `-- _pages_cache
     `-- _list_pages
         `-- _msg

Uses feature(s): _export_, _read_

Called by:

 Script-Body

_List of exports (to environment):_ new_updated_pages

_Environment variables used:_ no_pages_found [big]*//* file_ext

_pages_cache
~~~~~~~~~~~~

____
 ## 
 # @brief Cache the state of page files and identify changes.
 # @return Array of pages to be processed.
____

Has 31 line(s). Calls functions:

 _pages_cache
 `-- _list_pages
     `-- _msg

Called by:

 _pages

_p_qstags
~~~~~~~~~

____
 ## 
 # @brief Convert QStags to HTML using Perl.
 # @param content The content containing QStags.
 # @return The content with QStags converted to HTML.
____

Has 55 line(s). Calls functions:

 _p_qstags
 `-- _msg

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

_qstags
~~~~~~~

____
 ## 
 # @brief Convert QStags to HTML using Zsh regex module.
 # @param content The content containing QStags.
 # @return The content with QStags converted to HTML.
____

Has 50 line(s). Calls functions:

 _qstags
 `-- _msg

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

_run_engine
~~~~~~~~~~~

____
 ## 
 # @brief Run the configured engine to process the input file.
 # @param input The input file to be processed.
____

Has 11 line(s). Calls functions:

 _run_engine
 `-- _msg

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

_sitemap
~~~~~~~~

____
 ## 
 # @brief Generate the sitemap files if conditions are met.
____

Has 92 line(s). Calls functions:

 _sitemap
 `-- _msg

Uses feature(s): _setopt_

Called by:

 Script-Body

_Environment variables used:_ new_updated_blogs [big]*//* new_updated_pages [big]*//* sitemap_force

_version
~~~~~~~~

____
 ## 
 # @brief Display the version information of the script.
 # @param ... Additional arguments (unused in this function).
____

Has 4 line(s). Calls functions:

 _version
 `-- _msg

Called by:

 Script-Body

_youtube
~~~~~~~~

____
 ## 
 # @brief Embed a YouTube video in the provided content.
 # @param content The content containing #ytvideo tags.
 # @return The content with #ytvideo tags replaced by YouTube iframe embeds.
____

Has 18 line(s). Doesn't call other functions.

Not called by script or any function (may be e.g. a hook, a Zle widget, etc.).

