1
0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-11-24 11:52:34 +01:00
BookStack/resources/views
2022-06-25 14:24:38 +01:00
..
api-docs Added rate limit section to the API docs 2022-05-09 15:12:29 +01:00
attachments Updated attachment links to have dropdown for open type 2022-05-19 17:38:04 +01:00
auth Review and update of login auto initiation PR 2022-06-21 15:32:18 +01:00
books Extracted conversion text to translation file 2022-06-19 16:23:18 +01:00
chapters Extracted conversion text to translation file 2022-06-19 16:23:18 +01:00
comments Standardised dropdown list item styles, Extracted page editor toolbar 2022-04-20 14:03:47 +01:00
common Aligned other popup windows 2022-06-20 23:02:06 +01:00
entities Updated entity-selector-popup to reset on selection 2022-06-25 14:13:17 +01:00
errors Added help/about box to wysiwyg editor 2022-02-07 23:19:04 +00:00
exports Reorganised and split out export templates & styles 2022-06-08 17:56:59 +01:00
form Improved input size consistency 2022-05-14 16:05:29 +01:00
help Added ctrl+shift+k shortcut to WYSIWYG 2022-02-28 13:34:32 +00:00
home Removed dialog debug script from default home 2022-05-16 13:36:42 +01:00
layouts Added base template convenience partials for theme system users 2022-06-22 12:47:31 +01:00
mfa Standardised dropdown list item styles, Extracted page editor toolbar 2022-04-20 14:03:47 +01:00
misc Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
pages Added code editor changes mobile design handling 2022-06-20 23:12:07 +01:00
search Prevented created/update_by filters be wiped in search 2021-11-14 15:07:13 +00:00
settings Fixed non-translated category strings 2022-06-25 14:24:38 +01:00
shelves Cleaned up entity details listing 2022-05-13 18:03:43 +01:00
tags Added testing coverage for tag index 2021-11-06 21:54:02 +00:00
users Improved input size consistency 2022-05-14 16:05:29 +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