Writing Your Own Documentation

Bonfire makes including documentation with your application, or even just one of your custom modules, as simple as including some text files.

Docs Locations

To create application-specific documentation that can easily be versioned and shipped out with your application, simply place CommonMark-formatted text files in the application/docs folder.

For any modules that you create and want to create documentation for, just place the same CommonMark-formatted docs in the module's folder, under a new folder named docs.

my_module/
    css/
    docs/
    . . .

The files must have the file extension of .md in order to be recognized by the system.
When a help page is displayed, the Table of Contents in the sidebar will automatically find your docs and display them in the order found.

Custom Table of Contents

If you need more organization to your docs, you can specify a custom TOC to be used.
This allows for specifying custom names for the files, as well as splitting doc files into logical groups that you specify, but only one level deep.

To use a custom TOC, create a file called _toc.ini within your docs folder.
If this file is present, it will be used to display the links, instead of auto-generating the links from the existing files.
This file is a standard PHP .ini file.
The "options" within the file are the filename and the display name.
The filename is listed on the left of the '=' with the text used to display the link listed on the right.

my_page = My Great New Documentation Package

To group the files and provide a header, you would use the .ini's section syntax.

[Section 1]
my_page = My New Documentation Package

The filename must include in it's "path" the area the documentation came from, either 'application', 'bonfire', or your module's folder name.

application/my_page = My New Documentation Package
my_module/my_page   = My New Module Docs

Configuring Documentation

The docs system allows you to do some simple customization that allows you to integrate it into the needs of your application easily.
The system uses 2 groups 'application' and 'developer' to separate your application specific documentation from Bonfire's core documentation.

All documentation config settings can be found in the module's config file at bonfire/modules/docs/config/docs.php.

Theme

To specify a theme to be used only for the documentation, set the docs.theme setting.
This allows you to completely customize the how the information looks and is displayed to match your branding, ad needs, etc.

$config['docs.theme'] = 'docs';

Landing Page

You can customize the group that is shown if someone simply browses to /docs.

$config['docs.default_group'] = 'developer';

Which Groups Show?

You can configure whether application or developer documentation is displayed.

$config['docs.show_dev_docs'] = true;
$config['docs.show_app_docs'] = true;

Environment-based Display of docs

You can configure docs to be displayed based on the current environment by configuring the docs.permitted_environments variable.
If the current environment is not listed in the array, any user attempting to navigate to the docs module will be redirected to the site's base URL and an error message will be displayed.

$config['docs.permitted_environments'] = array('development', 'testing', 'production');

Override Application-configured CommonMark Driver

The docs module will use the application-configured CommonMark driver to parse the docs.
This value is normally set in /application/config/application.php.

If you use the CommonMark library elsewhere in your application, it will often make sense to configure one driver for your application and another for the docs module.
This can be done by setting docs.commonmark_driver in /docs/config/docs.php to the name of the desired driver.

$config['docs.commonmark_driver'] = 'MarkdownExtra';

__ci_last_regenerate	1776932910
requested_page	https://twsc.siamhybrid.com/docs/developer/writing_docs
previous_page	https://twsc.siamhybrid.com/docs/developer/writing_docs

Files

application.php
/home/siamhybr/twsc.siamhybrid.com/application/config/application.php

autoload.php
/home/siamhybr/twsc.siamhybrid.com/application/config/autoload.php

config.php
/home/siamhybr/twsc.siamhybrid.com/application/config/config.php

constants.php
/home/siamhybr/twsc.siamhybrid.com/application/config/constants.php

database.php
/home/siamhybr/twsc.siamhybrid.com/application/config/database.php

events.php
/home/siamhybr/twsc.siamhybrid.com/application/config/events.php

hooks.php
/home/siamhybr/twsc.siamhybrid.com/application/config/hooks.php

mimes.php
/home/siamhybr/twsc.siamhybrid.com/application/config/mimes.php

profiler.php
/home/siamhybr/twsc.siamhybrid.com/application/config/profiler.php

routes.php
/home/siamhybr/twsc.siamhybrid.com/application/config/routes.php

Base_Controller.php
/home/siamhybr/twsc.siamhybrid.com/application/core/Base_Controller.php

MY_Model.php
/home/siamhybr/twsc.siamhybrid.com/application/core/MY_Model.php

App_hooks.php
/home/siamhybr/twsc.siamhybrid.com/application/hooks/App_hooks.php

application_lang.php
/home/siamhybr/twsc.siamhybrid.com/application/language/english/application_lang.php

Profiler.php
/home/siamhybr/twsc.siamhybrid.com/application/libraries/Profiler.php

Base.php
/home/siamhybr/twsc.siamhybrid.com/application/third_party/MX/Base.php

Config.php
/home/siamhybr/twsc.siamhybrid.com/application/third_party/MX/Config.php

Controller.php
/home/siamhybr/twsc.siamhybrid.com/application/third_party/MX/Controller.php

Lang.php
/home/siamhybr/twsc.siamhybrid.com/application/third_party/MX/Lang.php

Loader.php
/home/siamhybr/twsc.siamhybrid.com/application/third_party/MX/Loader.php

error_php.php
/home/siamhybr/twsc.siamhybrid.com/application/views/errors/html/error_php.php

Benchmark.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Benchmark.php

CodeIgniter.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/CodeIgniter.php

Common.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Common.php

Config.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Config.php

Controller.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Controller.php

Exceptions.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Exceptions.php

Hooks.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Hooks.php

Input.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Input.php

Lang.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Lang.php

Loader.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Loader.php

Log.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Log.php

Model.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Model.php

Output.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Output.php

Router.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Router.php

Security.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Security.php

URI.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/URI.php

Utf8.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/Utf8.php

hash.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/compat/hash.php

mbstring.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/compat/mbstring.php

password.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/compat/password.php

standard.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/core/compat/standard.php

DB.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/database/DB.php

DB_driver.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/database/DB_driver.php

DB_query_builder.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/database/DB_query_builder.php

DB_result.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/database/DB_result.php

mysqli_driver.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/database/drivers/mysqli/mysqli_driver.php

mysqli_result.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/database/drivers/mysqli/mysqli_result.php

directory_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/helpers/directory_helper.php

form_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/helpers/form_helper.php

language_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/helpers/language_helper.php

url_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/helpers/url_helper.php

profiler_lang.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/language/english/profiler_lang.php

Cache.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/libraries/Cache/Cache.php

Cache_dummy.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/libraries/Cache/drivers/Cache_dummy.php

Driver.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/libraries/Driver.php

Session.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/libraries/Session/Session.php

Session_driver.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/libraries/Session/Session_driver.php

Session_database_driver.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/ci3/libraries/Session/drivers/Session_database_driver.php

BF_Lang.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/core/BF_Lang.php

BF_Loader.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/core/BF_Loader.php

BF_Model.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/core/BF_Model.php

BF_Router.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/core/BF_Router.php

BF_Security.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/core/BF_Security.php

BF_directory_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/helpers/BF_directory_helper.php

BF_form_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/helpers/BF_form_helper.php

application_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/helpers/application_helper.php

config_file_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/helpers/config_file_helper.php

markdown_extended_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/helpers/markdown_extended_helper.php

markdown_helper.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/helpers/markdown_helper.php

Assets.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/Assets.php

CommonMark.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/CommonMark.php

CommonMarkDriver.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/CommonMark/CommonMarkDriver.php

CommonMark_MarkdownExtended.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/CommonMark/drivers/CommonMark_MarkdownExtended.php

Console.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/Console.php

Events.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/Events.php

Modules.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/Modules.php

Route.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/Route.php

Template.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/libraries/Template.php

docs.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/docs/config/docs.php

routes.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/docs/config/routes.php

Docs.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/docs/controllers/Docs.php

docs_lang.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/docs/language/english/docs_lang.php

_sidebar.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/docs/views/_sidebar.php

index.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/docs/views/index.php

Settings_lib.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/settings/libraries/Settings_lib.php

Settings_model.php
/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/settings/models/Settings_model.php

index.php
index.php

index.php
themes/docs/index.php

42 ms	Loading Time: Base Classes
105 ms	Controller Execution Time ( Docs / Index )
182 ms	Total Execution Time

0.0006	SELECT GET_LOCK('a684ed9ed3d8010ded0cc52f4e153d1d', 300) AS ci_session_lockSpeed: 0.0006 - Possible keys: - Key Used: - Type: - Rows: - Extra: No tables used
0.0028	SELECT `data` FROM `bf_ci3_sessions` WHERE `id` = 'a684ed9ed3d8010ded0cc52f4e153d1d'Speed: 0.0028 - Possible keys: - Key Used: - Type: - Rows: - Extra: Impossible WHERE* noticed after reading const tables*
0.0009	SHOW TABLES FROM `siamhybr_twsc`
0.0031	SELECT * FROM `bf_settings`Speed: 0.0031 - Possible keys: - Key Used: - Type: ALL - Rows: 42 - Extra:
0.0074	Total Query Execution Time

HTTP_ACCEPT	/
HTTP_USER_AGENT	Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
HTTP_CONNECTION
SERVER_PORT	443
SERVER_NAME	twsc.siamhybrid.com
REMOTE_ADDR	216.73.217.24
SERVER_SOFTWARE	LiteSpeed
HTTP_ACCEPT_LANGUAGE
SCRIPT_NAME	/index.php
REQUEST_METHOD	GET
HTTP_HOST
REMOTE_HOST
CONTENT_TYPE
SERVER_PROTOCOL	HTTP/1.1
QUERY_STRING
HTTP_ACCEPT_ENCODING	gzip, br
HTTP_X_FORWARDED_FOR	216.73.217.24, 104.23.243.196

base_url	https://twsc.siamhybrid.com/
index_page
uri_protocol	AUTO
url_suffix
language	english
charset	UTF-8
enable_hooks	true
subclass_prefix	MY_
composer_autoload	false
permitted_uri_chars	a-z 0-9~%.:_-
allow_get_array	true
enable_query_strings	false
controller_trigger	c
function_trigger	m
directory_trigger	d
log_threshold	0
log_path	/home/siamhybr/twsc.siamhybrid.com/application/logs/
log_file_extension
log_file_permissions	420
log_date_format	Y-m-d H:i:s
error_views_path
cache_path	/home/siamhybr/twsc.siamhybrid.com/application/cache/
cache_query_string	false
encryption_key	d110143d6ce081a24de377692179008b
sess_cookie_name	bf_twsc_session
sess_expiration	7200
sess_time_to_update	300
sess_match_ip	false
sess_expire_on_close	false
sess_encrypt_cookie	false
sess_use_database	false
sess_table_name	sessions
sess_match_useragent	true
sess_driver	database
sess_regenerate_destroy	false
sess_save_path	ci3_sessions
cookie_prefix
cookie_domain
cookie_path	/
cookie_secure	false
cookie_httponly	false
standardize_newlines	false
global_xss_filtering	false
csrf_protection	false
csrf_token_name	ci_csrf_token
csrf_cookie_name	ci_csrf_token
csrf_expire	7200
csrf_regenerate	true
csrf_exclude_uris	Array ( )
compress_output	false
time_reference	utc
rewrite_short_tags	false
proxy_ips
bonfire.installed	1
site.default_user_timezone	UM8
modules_locations	Array ( [/home/siamhybr/twsc.siamhybrid.com/application/modules/] => ../../application/modules/ [/home/siamhybr/twsc.siamhybrid.com/bonfire/modules/] => ../../bonfire/modules/ )
site.backup_folder	archives/
contexts	Array ( [0] => content [1] => reports [2] => settings [3] => developer )
enable_activity_logging	true
sparks_path	../sparks/
template.site_path	/home/siamhybr/twsc.siamhybrid.com/public_html/
template.theme_paths	Array ( [0] => themes )
template.default_layout	index
template.ajax_layout	ajax
template.use_mobile_themes	false
template.default_theme	default/
template.admin_theme	admin
template.message_template	<div class="alert alert-{type} alert-dismissable"> <button type="button" class="close" data-dismiss="alert" aria-hidden="true">&times;</button> <div>{message}</div> </div>
template.breadcrumb_symbol	:
template.parse_views	false
assets.directories	Array ( [base] => assets [cache] => cache [css] => css [image] => images [js] => js [module] => module )
assets.js_opener	$(document).ready(function() {
assets.js_closer	});
assets.css_combine	false
assets.js_combine	false
assets.css_minify	true
assets.js_minify	true
assets.encrypt_name	false
assets.encode	false
assets.base_folder	assets
assets.asset_folders	Array ( [css] => css [js] => js [image] => images )
ui.current_shortcuts	Array ( [form_save] => Array ( [description] => Save any form in the admin area. [action] => $("input[name=save]").click();return false; ) [create_new] => Array ( [description] => Create a new record in the module. [action] => window.location.href=$("a#create_new").attr("href"); ) [select_all] => Array ( [description] => Select all records in an index page. [action] => $("table input[type=checkbox]").click();return false; ) [delete] => Array ( [description] => Delete the record(s). [action] => $("#delete-me.btn-danger").click(); ) [module_index] => Array ( [description] => Return to the index of the current module. [action] => window.location.href=$("a#list").attr("href"); ) [goto_content] => Array ( [description] => Jump to the Content context. [action] => window.location.href=$("#tb_content").attr("href") ) [goto_reports] => Array ( [description] => Jump to the Reports context. [action] => window.location.href=$("#tb_reports").attr("href") ) [goto_settings] => Array ( [description] => Jump to the Settings context. [action] => window.location.href=$("#tb_settings").attr("href") ) [goto_developer] => Array ( [description] => Jump to the Developer context. [action] => window.location.href=$("#tb_developer").attr("href") ) )
emailer.write_to_file	false
migrate.auto_core	false
migrate.auto_app	false
commonmark.valid_drivers	Array ( [0] => Parsedown [1] => Markdown [2] => MarkdownExtra [3] => LeagueCommonMark )
commonmark.driver	MarkdownExtended
docs.theme	docs
docs.default_group	developer
docs.show_dev_docs	true
docs.show_app_docs	true
docs.toc_file	_toc.ini
docs.permitted_environments	Array ( [0] => development [1] => testing [2] => production )

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

A PHP Error was encountered

Writing Your Own Documentation

Docs Locations

Custom Table of Contents

Configuring Documentation

Theme

Landing Page

Which Groups Show?

Environment-based Display of docs

Override Application-configured CommonMark Driver

Console

Memory Usage

Benchmarks

Queries

Session User Data

GET DATA

POST DATA

URI STRING

CLASS/METHOD

HTTP HEADERS

CONFIG VARIABLES

Files