History

Dan Brown c8b6f622f4 Added help/about box to wysiwyg editor - To display license info along with shortcuts. - Extracted out plain layout from 503 error page. - Added tests to ensure license references are as expected.		2022-02-07 23:19:04 +00:00
..
api-docs
attachments
auth
books	Added copy considerations	2021-12-20 17:33:19 +00:00
chapters	Added copy considerations	2021-12-20 17:33:19 +00:00
comments
common	Further adjusted linked image sizes on PDF export	2022-01-24 17:24:00 +00:00
entities	enh(recently updated): show updatedBy and updated_at	2022-01-19 21:49:45 +01:00
errors	Added help/about box to wysiwyg editor	2022-02-07 23:19:04 +00:00
form	Added timeout and debugging statuses to webhooks	2022-01-03 19:42:48 +00:00
help	Added help/about box to wysiwyg editor	2022-02-07 23:19:04 +00:00
home
layouts	Added help/about box to wysiwyg editor	2022-02-07 23:19:04 +00:00
mfa
misc
pages	Made WYSIWYG editor translatable	2022-02-06 21:17:08 +00:00
search
settings	Fixed default registration role display options	2022-01-31 14:16:56 +00:00
shelves
tags
users	Added language select to the user create form	2022-01-31 22:15:21 +00:00
vendor
readme.md

readme.md

BookStack Views

All views within this folder are Laravel blade views.

Overriding

Views can be overridden on a per-file basis via the visual theme system. More information on this can be found within the dev/docs/visual-theme-system.md file within this project.

Convention

Views are broken down into rough domain areas. These aren't too strict although many of the folders here will often match up to a HTTP controller.

Within each folder views will be structured like so:

- folder/
    - page-a.blade.php
    - page-b.blade.php
    - parts/
        - partial-a.blade.php
        - partial-b.blade.php
    - subdomain/
        - subdomain-page-a.blade.php
        - subdomain-page-b.blade.php
        - parts/
            - subdomain-partial-a.blade.php
            - subdomain-partial-b.blade.php

If a folder contains no pages at all (For example: attachments, form) and only partials, then the partials can be within the top-level folder instead of pages to prevent unneeded nesting.

If a partial depends on another partial within the same directory, the naming of the child partials should be an extension of the parent. For example:

- tag-manager.blade.php
- tag-manager-list.blade.php
- tag-manager-input.blade.php