bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Merge branch 'master' into v0.25

Browse source
This commit is contained in:
Dan Brown 2019-01-12 20:11:19 +00:00
commit 951169ba85
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
6 changed files with 22 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

2
content/docs/admin/ldap-auth.md
View file

@ -60,7 +60,7 @@ LDAP_VERSION=3
### LDAP Group Sync
BookStack has the ability to sync LDAP user groups with BookStack roles. By default this will match LDAP group names with the BookStack role display names with casing ignored.
This can be overridden by via the 'External Authentication IDs' field which can be seen when editing a role while LDAP authentication is enabled. If filled, names in this field will be used and the role name will be ignored. You can match on multiple names by separating them with a comma.
This can be overridden by via the 'External Authentication IDs' field which can be seen when editing a role while LDAP authentication is enabled. This field can be populated with common names (CNs) of accounts *or* groups. If filled, CNs in this field will be used and the role name will be ignored. You can match on multiple CNs by separating them with a comma.
This feature requires the LDAP server to be able to provide user groups when queried. This is enabled by default on ActiveDirectory via the 'memberOf' attribute but other LDAP systems may need to be configured to enable such functionality. If using OpenLDAP you'll need to setup the memberof overlay.

4
content/docs/admin/third-party-auth.md
View file

@ -113,7 +113,9 @@ To create a Twitter application for signing in with you may require a phone numb
3. In your new app select 'Add Product' on the left sidebar then choose 'Facebook Login' by clicking the 'Get Started' button. Select the 'Web' option if asked to choose a platform.
4. Enter the your base BookStack url into the 'Site URL' box and save.
5. On the left sidebar again go to 'Facebook Login' -> 'Settings'.
6. Enter your base BookStack URL again into the 'Valid OAuth redirect URIs' input and save.
6. Enter the following URLs under 'Valid OAuth Redirect URIs', changing `https://example.com` to your own domain where BookStack is hosted:
- `https://example.com/login/service/facebook/callback`
- `https://example.com/register/service/facebook/callback`
7. Navigate back to the app 'Dashboard' in the sidebar to find your app id and secret. Add or set these to your `.env` file like so:
```bash
# Replace the below (including '{}' braces) with your facebook APP_KEY and APP_SECRET

2
content/docs/user/content-overview.md
View file

@ -9,7 +9,7 @@ The principles of storing information within BookStack is based of the ideas of
Within a book you can directly create pages or you can first create chapters. Chapters provide an additional level of page grouping to keep pages organised but are optional. All the information you write is held within pages. Although books and chapters do not hold information they can be given a short description to assist with searching and visibility.
Once you start to stack-up books you can start to use Bookshelves to organise your Books. Bookshelves can contain mulitple books and a single books could be placed on multiple Bookshelves.
Once you start to stack-up books you can start to use Bookshelves to organise your Books. Bookshelves can contain mulitple books and a single book could be placed on multiple Bookshelves.
### Default Colour Coding

4
content/docs/user/organising-content.md
View file

@ -15,7 +15,7 @@ Books and chapters can be moved directly to a new chapter or book. To move a cha
![Page Move Menu](/images/docs/page-move-menu.png)
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 book 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.
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.
### Sorting Books
@ -23,4 +23,4 @@ The 'Book Sort' interface allows you to move multiple pages and chapters with ea
![Book Sort](/images/docs/book-sort.png)
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.
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.

16
content/docs/user/reusing-content.md
View file

@ -12,16 +12,16 @@ Note that the include behaviour is non-recursive so including will only work to
## Include Tags
To include the content of a page within another you can used the following syntax:
To include the content of a page within another you can use the following syntax:
`{{@page_id}}` or `@{{page_id#content_id}}`
`{{@page_id}}` or `{{@page_id#content_id}}`
Here are some examples of this in use:
* `{{@5}}` - Include all content from the page with an id of '5'.
* `{{@10#bkmrk-copyright-year}}` - Include the content within the element of id `bkmrk-copyright-year` in the page with an id of '10'.
* `{{@5}}` - Includes all the content from the page with an id of '5'.
* `{{@10#bkmrk-copyright-year}}` - Includes the content within the element of id `bkmrk-copyright-year` in the page with an id of '10'.
You simply enter that in the page editor and then, When the page is viewed, the content will be dynamically be fetched. This means you can update the referenced content and it will show the same changes on any page the content is included within.
You simply enter that in the page editor and then, when the page is viewed, the content will be dynamically be fetched. This means you can update the referenced content and it will show the same changes on any page the content is included within.
## Easily Grabbing the Syntax
@ -31,11 +31,11 @@ By default this contains a direct link to that content. If you click the link ic
<video controls src="/images/2017/01/bookstack-includes-popover.mp4"></video>
## Forcing Content ID's
## Forcing Content IDs
When including a specific block of content the id of the block is used (part after the hash). By default these are generated by BookStack when you save a page. If you are using the WYSIWYG editor the id will stay the same unless the block is removed or re-formatted. In the markdown editor it changes every save and references the content so while it may remain the same there's a good chance an ID can change.
When including a specific block of content the id of the block is used (part after the hash). By default these are generated by BookStack when you save a page. If you are using the WYSIWYG editor the id will stay the same unless the block is removed or re-formatted. In the markdown editor it changes with every save and references the content so while it may remain the same there's a good chance an ID can change.
Due to the fact ID's can change it's recommended to force ID's on you content:
Due to the fact IDs can change it's recommended to force IDs on your content:
#### WYSIWYG Editor

14
content/docs/user/searching.md
View file

@ -9,8 +9,8 @@ The ability to search your documentation is vital to day-to-day use.
There are a few locations within BookStack where you can search for your content.
Below is a list of search functions within BookStack:
* **Header Search Bar** - The search bar/link in the header of every page allows you to search from anywhere. This search is a global search which will look across all books, chapters and pages in your system. This page contains an interface to help you build a more advanced search. This interface simply generates a more advanced search term using the syntax described below.
* **Book/Chapter Search Bar** - When viewing a book or chapter a search bar can be found in the top of the right sidebar. These searches will look across all child items.
* **Header Search Bar** - The search bar/link in the header of every page allows you to search from anywhere. This search is a global search which will look across all books, chapters and pages in your system. After performing a search in this box you'll be led to a search page that includes options and features that can help you build a more advanced search.
* **Book/Chapter Search Bar** - When viewing a book or chapter a search bar can be found in the top of the left sidebar. These searches will look across all child items.
* **Move & Link Selection** - When choosing to move a page/chapter or when selecting a page/chapter/book to link to within the editor the most popular items are shown but you also have the ability to search.
---
@ -30,13 +30,13 @@ All of the above search locations within BookStack share the ability to use adva
<td>Normal Searches</td>
<td>&lt;term_a&gt; &lt;term_b&gt;</td>
<td>london meeting</td>
<td>Normal word search across the name and description or body of your content. When mulitple terms are searched only one term has to match your content but content containing both terms will be higher in the results.</td>
<td>Normal word searches across the name and description or body of your content. When mulitple terms are searched only one term has to match your content but content containing both terms will be higher in the results.</td>
</tr>
<tr>
<td>Exact Searches</td>
<td>"&lt;term&gt;"</td>
<td>"london meeting"</td>
<td>Exact matches will require that the whole string within quotes exists in your content in exactly the same format. Used this if you're looking for an exact phrase containing or if you need to search for a term with spaces in.</td>
<td>Exact matches will require that the whole string within quotes exists in your content in exactly the same format. Use this if you're looking for an exact phrase containing or if you need to search for a term with spaces in.</td>
</tr>
<tr>
<td>Tag Searches</td>
@ -51,7 +51,7 @@ All of the above search locations within BookStack share the ability to use adva
[location=london] <br>
[attendees>5]
</td>
<td>Tag searches allow you to find pages with that have specific tags applied. You can search by tag name, by tag value or by both name and value. When searching by tag value an operator must be used to define the match type. You can use <code>=</code>, <code>!=</code>, <code>&lt;</code>, <code>&gt;</code>,<code>&lt;=</code>, <code>&gt;=</code> or <code>like</code> as operators. When using the <code>like</code> operator you can use <code>%</code> symbols to represent wildcards in your search.</td>
<td>Tag searches allow you to find pages which have specific tags applied. You can search by tag name, by tag value or by both name and value. When searching by tag value an operator must be used to define the match type. You can use <code>=</code>, <code>!=</code>, <code>&lt;</code>, <code>&gt;</code>,<code>&lt;=</code>, <code>&gt;=</code> or <code>like</code> as operators. When using the <code>like</code> operator you can use <code>%</code> symbols to represent wildcards in your search.</td>
</tr>
<tr>
<td>Filter Searches</td>
@ -168,7 +168,7 @@ Filters are set advanced search features that can be used in your search term. T
{type:page|chapter} <br>
{type:book} <br>
</td>
<td>Restricts the types of content that will be in the search results. <br> Use of this will depend on the type of search. For example, In a chapter search only pages are shown so this has no effect.</td>
<td>Restricts the types of content that will be in the search results. <br> Use of this will depend on the type of search. For example, in a chapter search only pages are shown so this has no effect.</td>
</tr>
</table>
@ -188,7 +188,7 @@ Below are some examples of using the above syntax and filters with descriptions:
* `textbook discussion [meeting] {type:page} {created_by:me}`
* `textbook discussion` - Search content for the words `textbook` or `discussion`
* `[meeting]` - only show content that has a `meeting` tag applied
* `{type:page}` - only show pages, Hide chapters and books
* `{type:page}` - only show pages, hide chapters and books
* `{created_by:me}` - that was created by me.
<br>