As per PR #5800 * DB: Planned out new entity table format via migrations * DB: Created entity migration logic Made some other tweaks/fixes while testing. * DB: Added change of entity relation columns to suit new entities table * DB: Got most view queries working for new structure * Entities: Started logic change to new structure Updated base entity class, and worked through BaseRepo. Need to go through other repos next. Removed a couple of redundant interfaces as part of this since we can move the logic onto the shared ContainerData model as needed. * Entities: Been through repos to update for new format * Entities: Updated repos to act on refreshed clones Changes to core entity models are now done on clones to ensure clean state before save, and those clones are returned back if changes are needed after that action. * Entities: Updated model classes & relations for changes * Entities: Changed from *Data to a common "contents" system Added smart loading from builder instances which should hydrate with "contents()" loaded via join, while keeping the core model original. * Entities: Moved entity description/covers to own non-model classes Added back some interfaces. * Entities: Removed use of contents system for data access * Entities: Got most queries back to working order * Entities: Reverted back to data from contents, fixed various issues * Entities: Started addressing issues from tests * Entities: Addressed further tests/issues * Entities: Been through tests to get all passing in dev Fixed issues and needed test changes along the way. * Entities: Addressed phpstan errors * Entities: Reviewed TODO notes * Entities: Ensured book/shelf relation data removed on destroy * Entities: Been through API responses & adjusted field visibility * Entities: Added type index to massively improve query speed
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