Actualiser content/docs/admin/installation.md

[website] / content / docs / admin / hacking-bookstack.md

diff --git a/content/docs/admin/hacking-bookstack.md b/content/docs/admin/hacking-bookstack.md
index 080488c27df50277cb9e553ba1495eccf61084c2..fe105849cd35d556472d501a256d8ceb8ccda90f 100644 (file)
--- a/content/docs/admin/hacking-bookstack.md
+++ b/content/docs/admin/hacking-bookstack.md
@@ -9,8 +9,16 @@ Sometimes you may want to perform deeper customisation to BookStack or extend th
 
 _**Note: Customisation options on this page are not deemed to be stable or officially supported. BookStack core files may change on any release causing changes in behaviour to your hacks.**_
 
 
 _**Note: Customisation options on this page are not deemed to be stable or officially supported. BookStack core files may change on any release causing changes in behaviour to your hacks.**_
 

+{{<toc>}}
+

 ---
 
 ---
 

+### BookStack Hacks Directory
+
+This website has a directory of available hacks [which can be found here](/hacks/).
+These make use of the [Custom HTML Head Option](#custom-html-head-option), [Visual Theme System](#visual-theme-system) and [Logical Theme System](#logical-theme-system) options listed below.
+
+---

 
 ### BookStack API
 
 
 ### BookStack API
 


@@ -19,39 +27,15 @@ BookStack has a built-in REST API for external interaction and consumption of yo
 **Reference Links**
 
 - [API documentation of our demo instance](https://demo.bookstackapp.com/api/docs).
 **Reference Links**
 
 - [API documentation of our demo instance](https://demo.bookstackapp.com/api/docs).

-- [Our "BookStack API Scripts" repo containing examples](https://github.com/BookStackApp/api-scripts).
+- [Our "BookStack API Scripts" repo containing examples](https://codeberg.org/bookstack/api-scripts).

 
 ---
 
 ### Custom HTML Head Option
 
 
 ---
 
 ### Custom HTML Head Option
 

-Within the settings area you'll find a 'Custom HTML head content' setting. You can use this to add in any custom JavaScript or CSS content which enables you to override default BookStack functionality and styles.
-
----
-
-### BookStack Editor Events
-
-For the core underlying libraries, used in the BookStack page editors, we emit some custom events as part of their lifecycle.
-You can listen for these events to hook in and alter their configs or to gain a reference to the underlying editor instance.
-The below code sample shows the events available; Log out the `detail` property of events, as per the below example, to understand what is passed with the events:
+Within the "Settings > Customization" view within BookStack you'll find a "Custom HTML Head Content" setting. You can use this to add in any custom JavaScript or CSS content which enables you to override default BookStack functionality and styles.

 
 

-```html
-<script>
-       // TinyMCE WYSIWYG editor events
-       window.addEventListener('editor-tinymce::pre-init', event => console.log('TINYMCE-PRE_INIT', event.detail));
-       window.addEventListener('editor-tinymce::setup', event => console.log('TINYMCE-SETUP', event.detail));
-
-       // CodeMirror / Markdown-it Markdown editor events
-       window.addEventListener('editor-markdown-cm::pre-init', event => console.log('MARKDOWN-CODEMIRROR-PRE_INIT', event.detail));
-       window.addEventListener('editor-markdown::setup', event => console.log('MARKDOWN-EDITOR-SETUP', event.detail));
-
-       // Diagrams.net configure event
-       // Reference: https://www.diagrams.net/doc/faq/configure-diagram-editor
-       // If using a custom diagrams.net instance, via the `DRAWIO` option, you will need to ensure
-       // this your URL has the `configure=1` query parameter.
-       window.addEventListener('editor-drawio::configure', event => console.log('DIAGRAMS.NET-CONFIGURE', event.detail));
-</script>
-```
+You can find examples of custom HTML Head customizations on the [hacks part of this site](/hacks/).

 
 ---
 
 
 ---
 


@@ -62,6 +46,7 @@ Documentation for this system is contained within [the project repo here](https:
 
 _**Note: The files that can be override using the theme system are not deemed to be stable. BookStack core files may change on any release causing changes in behaviour to your overrides. Theme overrides are not officially supported in any way.**_
 
 
 _**Note: The files that can be override using the theme system are not deemed to be stable. BookStack core files may change on any release causing changes in behaviour to your overrides. Theme overrides are not officially supported in any way.**_
 

+You can find examples visual theme system customizations on the [hacks part of this site](/hacks/).

 
 ---
 
 
 ---
 


@@ -71,4 +56,67 @@ BookStack allows PHP code-based extension via what we call the "Logical Theme Sy
 This works by hooking into specific events where you can then perform custom actions or extension of the underlying framework.
 Documentation for this system is contained within [the project repo here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/logical-theme-system.md).
 
 This works by hooking into specific events where you can then perform custom actions or extension of the underlying framework.
 Documentation for this system is contained within [the project repo here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/logical-theme-system.md).
 

-_**Note: Only the API described in the logical-theme-system document is considered stable & supported. Any usage of other application classes is regarded as unstable and unsupported.**_
\ No newline at end of file
+_**Note: Only the API described in the logical-theme-system document is considered stable & supported. Any usage of other application classes is regarded as unstable and unsupported.**_
+
+You can find examples of logical theme system customizations on the [hacks part of this site](/hacks/).
+
+---
+
+<a id="bookstack-editor-events" data-info="Anchor here for backwards compatibility of existing links"></a>
+
+### BookStack JavaScript Public Events
+
+To allow customization of the JavaScript libraries & components used, BookStack emits events as part of their lifecycle
+so that you can define listeners to hook into these events. These can often be used by adding scripts to the 
+[custom HTML head content option](#custom-html-head-option).
+
+You can find details and a listing of all events [within the project repo here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md).
+
+---
+
+### Tag Classes
+
+While primarily for categorization, tags within BookStack can also provide opportunities for customization.
+When viewing an item with tags applied, those tags will be normalized to CSS classes and applied to the `<body>` element of the page. As an example, a tag name/value pair of `Priority: Critical` will apply the following classes to the body:
+
+- tag-name-priority
+- tag-value-critical
+- tag-pair-priority-critical
+
+For the normalization to classes, the following is done to both the name and value of the tag:
+
+- Text is lower-cased
+- Spaces and hyphens are stripped
+
+This normalization provides relatively stable class naming for CSS targeting, but note it does mean that two tags, of different values, could be normalized to the same CSS class names in some scenarios.
+
+As an example of usage, pages with the tag `Priority: Critical` could have their text made red with the following "Custom HTML Head Content" setting value:
+
+```html
+<style>
+.tag-pair-priority-critical .page-content { color: red; }
+</style>
+```
+
+---
+
+### Export Classes
+
+When PDF or HTML exports are performed in BookStack, the underlying templates define classes to allow customization of styling in specific scenarios.
+For context, PDF exports are rendered via a conversion from HTML to PDF, so CSS styling can be applied for these but support may depend on the underlying PDF conversion engine.
+The classes are applied to the `<body>` element, and are as follows:
+
+- `export` - All HTML/PDF exports
+- `export-format-pdf` - PDF exports
+- `export-format-html` - HTML exports
+- `export-engine-dompdf` - PDF exports using the default DomPDF rendering engine
+- `export-engine-wkhtml` - PDF exports using the default DomPDF rendering engine
+- `export-engine-command` - PDF exports using the command-based PDF rendering option
+
+As an example usage, you could define the following custom style code to make paragraph text red only in PDF exports created via the default DomPDF renderer:
+
+```html
+<style>
+.export-format-pdf.export-engine-dompdf p { color: red; }
+</style>
+```
\ No newline at end of file