**Upgrade Notices**
-TODO
+TODO - Copy to updates page
-- **Category** - Notice
+- **PHP Version Requirement Change** - The minimum supported PHP version has changed from PHP 8.0.2 to PHP 8.1 in this release. Please see our ["Updating PHP & Composer" documentation page](/docs/admin/updating-php/#updating-php) for guidance on updating PHP.
+- **Sorting** - Basic sort order changes for chapters and pages will no longer affect the "updated" time for these items. Wider changes during sorting (moving to a new parent) will still increment the "updated" time.
TODO - Video
<!-- {{<pt imWKrALvSwokP3vrjRdUXh>}} -->
TODO
+
+### Search Indexing Improvements
+
+The way BookStack indexes content for search now follows more advanced logic
+for this release to address some common limitation faced.
+Specifically, single terms containing certain punctuation like `.` periods
+would have previously been split, leaving any searches for terms like "24.5"
+falling back to slower exact matches.
+
+As of v25.02, BookStack will now index the non-split term in addition to the split term,
+allowing both to match with indexed and scored results.
+In additions to `.` periods, this is also done for `-` hyphens which we previously did not
+consider before.
+
+Lastly, «giullemets» are now considered as punctuation in the same manner as other brackets.
+
+Note that to receive this improvements for existing content, you'll need to
+[regenerate the search index](/docs/admin/commands/#regenerate-the-search-index) after upgrading.
+
### Translations
TODO
php artisan bookstack:update-url http://docs.example.com https://demo.bookstackapp.com
```
+This **will not** change the `APP_URL` option set in your configuration. If changing your BookStack URL, you will also need to change that `.env` file option to match your new instance URL.
+
### Reset User MFA Methods
This will reset/clear any existing multi-factor-authentication methods for the given user. If MFA
php artisan bookstack:regenerate-references
```
+### Assign Sort Rule
+
+Assigns and runs the specified [sort rule](/docs/user/organising-content/#sort-rules) to the specified content in batch.
+Running the command without any arguments will list the existing sort rules
+in the system as an easy method to get their IDs.
+A flag is required to specific which content to assign the rule to. The available options
+are shown in the examples below.
+
+```bash
+# Format
+php artisan bookstack:assign-sort-rule <sort_rule_id> <assignment-flag>
+
+# Assign sort rule 4 to all books
+php artisan bookstack:assign-sort-rule 4 --all-books
+
+# Assign sort rule 19 to all books which don't already have a sort rule assigned
+php artisan bookstack:assign-sort-rule 19 --books-without-sort
+
+# Assign sort rule 2 to books which already have sort rule 7 assigned
+# This is useful to switch the sort rule of many books
+php artisan bookstack:assign-sort-rule 2 --books-with-sort=7
+
+# List out available sort rules
+php artisan bookstack:assign-sort-rule
+```
+
### Delete Users
Delete all users from the system that are not original "admin" or system-level users.
BookStack has the following core requirements:
-* **PHP** >= 8.1
+* **PHP** >= 8.2
* For installation and maintenance, you'll need to be able to run `php` from the command line.
* Required Extensions: gd, dom, iconv, mbstring, mysqlnd, openssl, pdo, pdo_mysql, tokenizer, xml, zip.
* Optional Extensions: ldap *(If wanting to use LDAP Auth)*, exif *(For accurate image rotation handling)*.
## Updating PHP
-Currently the minimum version of PHP required by BookStack is PHP 8.1. You'll need to update PHP if using a version lower than 8.1.
+Currently the minimum version of PHP required by BookStack is PHP 8.2. You'll need to update PHP if using a version lower than 8.2.
You can usually check your installed PHP version by running `php -v` but in some cases your web-server could be running a different PHP version than what the command line reflects.
<details>
Pages and chapters can be moved directly to a new chapter or book. To move a chapter or page in this way, go to a page or chapter and select 'Move' in the actions list:
-<img alt="Page Move Action" src="/images/docs/page-move.png" width="240">
+<img alt="Page Move Action" src="/images/docs/user/page-move.png" width="240">
Clicking the 'Move' action will take you to a screen where you can select a new location for your chapter or page. Here you can search for a particular book or chapter using the search bar at the top of the selection screen. Once you select a new parent for your chapter or page press 'Move Page' or 'Move Chapter' and your chapter or page will be moved to the new chapter or book. If you move a chapter all child pages will remain in that chapter and any related activity will now show up under the new parent book.
The 'Book Sort' interface allows you to move multiple pages and chapters with ease in a simple drag and drop interface. To sort the content of a Book content, open the Book and find the "Sort" option within the actions list.
-
+
Initially, just the book you came from will show on the left. You can add extra books into the sort interface by selecting them on the right. Here you can simply drag and drop chapters and pages around and also between different books. Once you have organised your content press 'Save' and all included books will be re-organised.
+If you'd instead want books sorted automatically, refer to the [Sort Rules](#sort-rules) section below.
+
#### Permissions Required for Sorting
Since content during a sort can be moved to new locations, the results of sorting can alter the applied visibility & permissions of your content.
- Create permissions for pages in `Book B`
- Delete permissions for pages in `Book A`
+### Sort Rules
+
+For automatic sorting of content sort rules can be used.
+These are predefined sorting operations which be assigned to books.
+They are managed by admin-level users via the "Settings > Sorting" view,
+and they allow multiple sort actions to be configured which will be performed in order:
+
+
+
+Sort rules can then be used in the following locations:
+
+- As the "Default Book Sort" option in "Settings > Sorting", which will apply the configured sort to all newly created books thereafter.
+- Assigned to a specific book, by the "Auto Sort Option" in the "Sort" view of a book.
+- Batch assigned to content, via the ["Assign Sort Rule" command](/docs/admin/commands/#assign-sort-rule).
+
+Once assigned to a book, the sort operation will automatically run on each event which could
+affect the sort order (page update, chapter creation etc...).
+
+Sort rules can be assigned to book if a user has permission to edit that book,
+but the creation and modification of sort rules can only be done with users that
+have permission to manage application settings.
+This allows admin users to centrally manage the available rules and their behaviour
+while allowing sort assignment and execution to users with lower level permissions.
+
+#### Sort Rule Operations
+
+Here are details of each of the available sort rule operations:
+
+- **Name - Alphabetical:** Case insensitive basic alphabetical sort using the name.
+- **Name - Numeric:** Will attempt to parse a numeric value (24, 24.125), up to one decimal point, from the start of the name and sort on that.
+- **Created Date:** Sort by the content's creation date.
+- **Updated Date:** Sort by the content's updated date.
+- **Chapters First/Last:** Move chapters to the start/end of the ordering.
+
+Typically you would only use one or two operations, since most would override the rule prior.
+
### Books & Shelves
A bookshelf can contain multiple books and a book can be on multiple shelves. To add an existing book to a shelf start by opening the shelf you wish to move the book to and then press "Edit". Under the "Add books to this shelf" section find & select the book that you wish to move into the shelf you are currently editing and then choose "Save Shelf". Within that same interface you can alternatively drag books between the two lists, and you can drag books around in the left-hand list to dictate the default ordering of books within that shelf.
+++ /dev/null
-version https://git-lfs.github.com/spec/v1
-oid sha256:3bf432f11043ea23c6bb9f01c0341cdce20149ff53c916290707fd24c27cce93
-size 43243
--- /dev/null
+version https://git-lfs.github.com/spec/v1
+oid sha256:f57a2a181f2590f8e21aec959875da8d0d633202094a7a5b83e8c85b4e7f36a3
+size 53150
--- /dev/null
+version https://git-lfs.github.com/spec/v1
+oid sha256:b31a51a637eff3e2bf157722eebedc271e19794b8dead60be66ae0073d027529
+size 46648
projects / website / commitdiff
