### New Importable Export Format
-TODO
+A new export option is now available for books, chapters & pages: "Portable ZIP"
+
+TODO - Image of export options
+
+This exports your content within a compressed ZIP file, containing common
+related data including tags, attachments and images.
+
+These ZIP files can then be imported back into your instance, or you could even
+import these into other BookStack instances (as long as they're on v24.12 or greater).
+During the import process, you're provided an overview of the content you're due to import
+and are able to choose the target parent location (for chapter and page imports):
+
+TODO - Image of in progress Import overview
+
+Upon import, all the content of the ZIP will be added to the target BookStack instance, with attachments & images
+uploaded into the system, and links between items in the import handled to point to the correct location in the target instance.
+
+To support this addition, A new "Import content" role permission has been added
+which will only be assigned to admin level roles by default (those who can change app settings).
+With this permission assigned, a user can access the "Import" view via the actions on the Books list view.
+
+TODO - Image of import list
+
+On this page you can upload a ZIP to start an import, or see existing pending imports.
+Users will only see their own import uploads by default, but users with permission to change app settings
+will be able to see all pending imports from all users.
+
+The ZIP format & structure has been specifically designed to be simple and easy to understand for developers.
+The format is [fully documented here](https://github.com/BookStackApp/BookStack/blob/development/dev/docs/portable-zip-file-format.md)
+so ensure the format is accessible to developers.
+
+To be clear, this is not intended as a backup format. There's a lot of metadata that is not part of these exports, so backups
+should still be done at an instance level following our guidance.
+That said, there's a lot of opportunity that I'm excited about in this portable and stable common import/export format.
+
+Here's some ideas in how this new format could be potentially used:
+
+- Export & import template books
+- Sharing books between different BookStack instances
+- Target format for building migration tools
+- Easier access/display of content in external applications
+- A way to "Promote" content from a "Staging" instance to a "Production" instance
+
+One notable limitation is that there's not yet API endpoints provided for import/export of this format.
+This was initially planned, but I want delay that for a while to ensure the process we have works, before adding API
+support since there'd otherwise be a significant chance of API breaking changes.
### New WYSIWYG Editor Updates
-TODO
+In the [last release we introduced](/blog/bookstack-release-v24-10/#new-alpha-wysiwyg-editor-option)
+the new WYSIWYG editor in alpha testing. It remains in an alpha-testing state for this release, but
+it's received a number of improvements:
+
+- Dark mode is now supported.
+- The UI will now properly adapt for mobile screen sizes.
+- URLs will auto-link on enter/space.
+- An "About/help" modal & button have been added.
+- Behaviour of collapsible blocks has been improved & made consistent.
+- Selection and nesting behaviour of lists has been improved.
+
+Upon these user-facing improvements, work has gone into further merge & develop the underlying
+codebase for this editor since we decided to fork in the [Lexical](https://lexical.dev/) editor core code late in the last
+development cycle.
### API Improvements
-TODO
+A couple of existing API endpoints have received enhancements for this release:
+
+- The `/api/search` endpoint will now include parent chapter/book names for easier access & display in search results lists.
+- Cover image details are now provided on the `/api/books` and `/api/shelves` endpoints.
+
+Thanks to [@rashadkhan359](https://github.com/BookStackApp/BookStack/pull/5280) for their contributions as part of these improvements.
### LDAP: Support for multiple name attributes
-TODO
+For users using LDAP for authentication, it's now possible to make of multiple LDAP
+attributes for a user's name. To do this, you can just define multiple
+attributes in the `LDAP_DISPLAY_NAME_ATTRIBUTE` setting separated with a pipe like so:
+
+```bash
+LDAP_DISPLAY_NAME_ATTRIBUTE="firstname|lastname"
+```
+
+Values of those properties will then be combined with a space.
+In the above example upon first login, if the LDAP user data has a `firstname` of `Barry` and a
+`lastname` of `Chuckle`, their name in BookStack would be `Barry Chuckle` as a result.
+
+Thanks to [@MatthieuLeboeuf](https://github.com/BookStackApp/BookStack/pull/5295) for working on this one!
### Translations
### Next Steps
-TODO
+Our next main release will probably be a maintenance release. With PHP 8.4 we're hitting a lot of PHP deprecations which we can't
+overcome without updating our framework and minimum PHP version, we we'll probably get our yearly update in that regard out the way a
+little sooner, but dropping PHP 8.1 support will need a little extra work due to its widespread use.
+
+I'd also like to tie up some loose ends, like provide some more options for the [PDF export command we added this year](/blog/bookstack-release-v24-05/#command-based-pdf-export-option).
+Other than that I'd like to spend a fair bit more time on the new editor so it can move into a more "Beta" status for the next release
+to continue it's journey to eventually becoming the default option.
### Full List of Changes
**Released in v24.12**
-TODO
+* Added new portable ZIP import/export format. ([#5260](https://github.com/BookStackApp/BookStack/pull/5260), [#43](https://github.com/BookStackApp/BookStack/issues/43))
+* Added support for concatenating multiple LDAP attributes in displayName. Thanks to [@MatthieuLeboeuf](https://github.com/BookStackApp/BookStack/pull/5295). ([#5295](https://github.com/BookStackApp/BookStack/pull/5295), [#1684](https://github.com/BookStackApp/BookStack/issues/1684))
+* Added book and chapter titles to search API results. Thanks to [@rashadkhan359](https://github.com/BookStackApp/BookStack/pull/5280). ([#5280](https://github.com/BookStackApp/BookStack/pull/5280), [#5140](https://github.com/BookStackApp/BookStack/issues/5140))
+* Added cover image details to book/shelf API list responses. ([#5180](https://github.com/BookStackApp/BookStack/issues/5180))
+* Updated dev dockerfile setup to simplify things. Thanks to [@johnroyer](https://github.com/BookStackApp/BookStack/pull/5293). ([#5293](https://github.com/BookStackApp/BookStack/pull/5293))
+* Updated guest account form to hide language preference to prevent confusion. ([#5356](https://github.com/BookStackApp/BookStack/issues/5356))
+* Updated new WYSIWYG editor codebase to merge nodes & re-organise code. ([#5349](https://github.com/BookStackApp/BookStack/pull/5349))
+* Updated notification handling to not block user with errors on send failures. ([#5315](https://github.com/BookStackApp/BookStack/issues/5315))
+* Updated our JavaScript service files to TypeScript. ([#5259](https://github.com/BookStackApp/BookStack/pull/5259))
+* Updated project NPM package & SASS deprecations/changes. ([#5354](https://github.com/BookStackApp/BookStack/pull/5354))
+* Updated the new WYSIWYG editor with a range of fixes/updates. ([#5365](https://github.com/BookStackApp/BookStack/pull/5365))
+* Updated translations with latest Crowdin changes. ([#5345](https://github.com/BookStackApp/BookStack/pull/5345))
+* Fixed API attachment update issue when name not provided . ([#5353](https://github.com/BookStackApp/BookStack/issues/5353))
+* Fixed attachment actions showing when lacking permissions. ([#5323](https://github.com/BookStackApp/BookStack/issues/5323))
+* Fixed missing book description and extra newlines in markdown exports. Thanks to [@czemu](https://github.com/BookStackApp/BookStack/pull/5313). ([#5313](https://github.com/BookStackApp/BookStack/pull/5313))
+* Fixed page content indexing breaking with very large amounts of content. ([#5322](https://github.com/BookStackApp/BookStack/issues/5322))
**Released in v24.10.3**
projects / website / commitdiff