ZIP imports: Started actual import logic

[bookstack] / dev / docs / portable-zip-file-format.md

diff --git a/dev/docs/portable-zip-file-format.md b/dev/docs/portable-zip-file-format.md
index 7a99563d14b71bf9e68c6c470137fc743db8191c..7e5df3f015b263ca4af736a942d4c1f62483c8d6 100644 (file)
--- a/dev/docs/portable-zip-file-format.md
+++ b/dev/docs/portable-zip-file-format.md
@@ -46,13 +46,12 @@ This can be done using the following format:
 [[bsexport:<object>:<reference>]]
 ```
 
-Images and attachments are referenced via their file name within the `files/` directory.
-Otherwise, other content types are referenced by `id`.
+References are to the `id` for data objects.
 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:image:22]]
+[[bsexport:attachment:55]]
 [[bsexport:page:40]]
 [[bsexport:chapter:2]]
 [[bsexport:book:8]]
@@ -88,7 +87,7 @@ The `id_ciphertext` is the ciphertext of encrypting the text `bookstack`. This i
 - `id` - Number, optional, original ID for the book from exported system.
 - `name` - String, required, name/title of the book.
 - `description_html` - String, optional, HTML description content.
-- `cover` - String reference, options, reference to book cover image.
+- `cover` - String reference, optional, reference to book cover image.
 - `chapters` - [Chapter](#chapter) array, optional, chapters within this book.
 - `pages` - [Page](#page) array, optional, direct child pages for this book.
 - `tags` - [Tag](#tag) array, optional, tags assigned to this book.
@@ -121,10 +120,14 @@ The page editor type, and edit content will be determined by what content is pro
 
 #### Image
 
+- `id` - Number, optional, original ID for the page from exported system.
 - `name` - String, required, name of image.
 - `file` - String reference, required, reference to image file.
+- `type` - String, required, must be 'gallery' or 'drawio'
 
-File must be an image type accepted by BookStack (png, jpg, gif, webp)
+File must be an image type accepted by BookStack (png, jpg, gif, webp).
+Images of type 'drawio' are expected to be png with draw.io drawing data
+embedded within it.
 
 #### Attachment
 
@@ -132,12 +135,10 @@ File must be an image type accepted by BookStack (png, jpg, gif, webp)
 - `name` - String, required, name of attachment.
 - `link` - String, semi-optional, URL of attachment.
 - `file` - String reference, semi-optional, reference to attachment file.
-- `order` - Number, optional, integer order of the attachments (shown low to high).
 
 Either `link` or `file` must be present, as that will determine the type of attachment. 
 
 #### Tag
 
 - `name` - String, required, name of the tag.
-- `value` - String, optional, value of the tag (can be empty).
-- `order` - Number, optional, integer order of the tags (shown low to high).
\ No newline at end of file
+- `value` - String, optional, value of the tag (can be empty).
\ No newline at end of file