BookStack/resources/views
2022-09-28 20:15:48 +01:00
..
api-docs Added api format advisory regarding PUT/DELETE form data 2022-09-28 20:15:48 +01:00
attachments
auth
books Aligned bookshelf terminology to consistently be 'Shelf' 2022-09-01 14:55:35 +01:00
chapters Rolled out reference pages to all entities, added testing 2022-08-19 22:40:44 +01:00
comments
common
entities Updated page revisions link visibility 2022-09-03 12:32:21 +01:00
errors
exports
form
help Added ordered/unordered WYSIWYG list shortcuts 2022-07-26 16:43:15 +01:00
home
layouts Added convenience theme system partials for export layouts 2022-08-09 13:46:52 +01:00
mfa
misc
pages Applied permissions to revision action visibility 2022-09-28 11:10:06 +01:00
search Started removal of non-view permission queries 2022-07-13 15:23:03 +01:00
settings Added image view access notice to role form 2022-09-06 17:20:35 +01:00
shelves Rolled out reference pages to all entities, added testing 2022-08-19 22:40:44 +01:00
tags
users
vendor
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