1
0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-30 07:32:39 +01:00
BookStack/resources/views
Dan Brown 847a57a49a
Shelf permissions: Removed unused 'create' permission from view
Was causing confusion.
Added test to cover.
Also added migration to remove existing create entries to pre-emptively
avoid issues in future if 'create' is used again.
2023-06-25 23:22:49 +01:00
..
api-docs API Docs: Allowed multi-paragraph descriptions 2023-06-20 23:44:39 +01:00
attachments Allowed attachment drag via main text link 2023-05-22 20:23:19 +01:00
auth Updated email confirmation flow so confirmation is done via POST 2022-11-12 15:11:59 +00:00
books Rolled out use of seperate link color style 2023-01-28 16:06:11 +00:00
chapters Rolled out use of seperate link color style 2023-01-28 16:06:11 +00:00
comments Comments: Added read-only listing into page editor 2023-06-16 13:08:04 +01:00
common Update JS to show live changes and set light color values 2023-01-28 17:11:15 +00:00
entities Played around with a new app structure 2023-05-17 17:56:55 +01:00
errors Added help/about box to wysiwyg editor 2022-02-07 23:19:04 +00:00
exports Updated migration to carry across more colors, updated export 2023-01-28 17:49:48 +00:00
form Shelf permissions: Removed unused 'create' permission from view 2023-06-25 23:22:49 +01:00
help Added ordered/unordered WYSIWYG list shortcuts 2022-07-26 16:43:15 +01:00
home Rolled out use of seperate link color style 2023-01-28 16:06:11 +00:00
layouts Rolled out use of seperate link color style 2023-01-28 16:06:11 +00:00
mfa Rolled out use of seperate link color style 2023-01-28 16:06:11 +00:00
misc Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
pages Comments: Added read-only listing into page editor 2023-06-16 13:08:04 +01:00
search Added new endpoint for search suggestions 2022-11-21 10:35:53 +00:00
settings Played around with a new app structure 2023-05-17 17:56:55 +01:00
shelves Applied shelf book sort changes from testing 2023-02-17 16:18:24 +00:00
tags Played around with a new app structure 2023-05-17 17:56:55 +01:00
users Fixed issue with user delete ownership not migrating 2023-03-24 14:43:48 +00: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