BookStack/resources/views
2021-09-03 23:32:42 +01:00
..
api-docs Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
attachments Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
auth Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
books Added role permissions for exporting content 2021-08-28 21:48:17 +01:00
chapters Added role permissions for exporting content 2021-08-28 21:48:17 +01:00
comments Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
common Started application of CSP headers 2021-09-03 23:32:42 +01:00
entities Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
errors Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
form Added notice for lack of shelf permission cascade 2021-08-28 15:44:44 +01:00
home Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
layouts Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
mfa Made the TOTP URL visible during setup 2021-09-01 20:58:19 +01:00
misc Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
pages Added role permissions for exporting content 2021-08-28 21:48:17 +01:00
search Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
settings Added role permissions for exporting content 2021-08-28 21:48:17 +01:00
shelves Added notice for lack of shelf permission cascade 2021-08-28 15:44:44 +01:00
users Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
vendor Revert "Added app logo to outgoing emails" 2021-05-26 17:13:59 +01:00
readme.md Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00

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