webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-28 17:02:04 +03:00
Code Activity

ZIP Exports: Finished up format doc, move files, started builder

Browse Source 
Moved all existing export related app files into their new own dir.
This commit is contained in:
Dan Brown
2024-10-15 16:14:11 +01:00
parent 42bd07d733
commit 42b9700673
15 changed files with 118 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
dev/docs/portable-zip-file-format.md
View File

@ -39,18 +39,24 @@ Some properties in the export data JSON are indicated as `String reference`, and
}
```
TODO - Jotting out idea below.
Would need to validate image/attachment paths against image/attachments listed across all pages in export.
Probably good to ensure filenames are ascii-alpha-num.
`[[bsexport:image:an-image-path.png]]`
`[[bsexport:attachment:an-image-path.png]]`
`[[bsexport:page:1]]`
`[[bsexport:chapter:2]]`
`[[bsexport:book:3]]`
Within HTML and markdown content, you may require references across to other items within the export content.
This can be done using the following format:
TODO - Define how we reference across content:
TODO - References from in-content to file URLs
TODO - References from in-content to in-export content (page cross links within same export).
```
[[bsexport:<object>:<reference>]]
```
Images and attachments are referenced via their file name within the `files/` directory.
Otherwise, other content types are referenced by `id`.
Here's an example of each type of such reference that could be used:
```
[[bsexport:image:an-image-path.png]]
[[bsexport:attachment:an-image-path.png]]
[[bsexport:page:40]]
[[bsexport:chapter:2]]
[[bsexport:book:8]]
```
## Export Data - `data.json`