bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Documented editor shortcuts

Browse source 
Closes BookStackApp/BookStack#452
This commit is contained in:
Dan Brown 2017-07-28 12:26:54 +01:00
commit 5743ca3c6e
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
8 changed files with 170 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

77
content/docs/user/markdown-editor.md Normal file
View file

@ -0,0 +1,77 @@
+++
title = "Markdown Editor"
description = "Details on using the markdown editor in BookStack"
date = "2017-07-28"
type = "user-docs"
+++
If you prefer the write in Markdown the editor in BookStack can be changed at a instance level
to use a markdown editor instead of the default WYSIWYG editor.
The option to use Markdown is currently **not** a user setting but a global instance setting
due to formatting differences between the two editors.
### Editor Shortcuts
The following shortcuts are available in the Markdown Editor:
<table>
<thead>
<tr>
<th>Shortcut (Windows &amp; Linux/Mac)</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Ctrl+S</code> / <code>Cmd+S</code></td>
<td>Save Draft</td>
</tr>
<tr>
<td>
<code>Ctrl+1</code> / <code>Cmd+1</code> <br>
<code>Ctrl+2</code> / <code>Cmd+2</code> <br>
<code>Ctrl+3</code> / <code>Cmd+3</code> <br>
<code>Ctrl+4</code> / <code>Cmd+4</code>
</td>
<td>
Header Large (h2)<br>
Header Medium (h3)<br>
Header Small (h4)<br>
Header Tiny (h5)
</td>
</tr>
<tr>
<td><code>Ctrl+5</code> / <code>Cmd+5</code><br><code>Ctrl+D</code> / <code>Cmd+D</code></td>
<td>Normal Paragraph</td>
</tr>
<tr>
<td><code>Ctrl+6</code> / <code>Cmd+6</code><br><code>Ctrl+Q</code> / <code>Cmd+Q</code></td>
<td>Blockquote</td>
</tr>
<tr>
<td><code>Ctrl+7</code> / <code>Cmd+7</code><br><code>Ctrl+E</code> / <code>Cmd+E</code></td>
<td>Code Block</td>
</tr>
<tr>
<td><code>Ctrl+8</code> / <code>Cmd+8</code><br><code>Ctrl+Shift+E</code> / <code>Cmd+Shift+E</code></td>
<td>Inline Code</td>
</tr>
<tr>
<td><code>Ctrl+9</code> / <code>Cmd+9</code></td>
<td>Callout (Info)</td>
</tr>
<tr>
<td><code>Ctrl+K</code> / <code>Cmd+K</code></td>
<td>Insert Link</td>
</tr>
<tr>
<td><code>Ctrl+Shift+K</code> / <code>Cmd+Shift+K</code></td>
<td>Show link selector</td>
</tr>
<tr>
<td><code>Ctrl+Shift+I</code> / <code>Cmd+Shift+I</code></td>
<td>Insert Image</td>
</tr>
</tbody>
</table>

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

@ -31,7 +31,7 @@ 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 ID's
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.

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

@ -21,10 +21,10 @@ All of the above search locations within BookStack share the ability to use adva
<table width="100%">
<tr style="font-weight:bold;">
<td width="16%">Search Type</td>
<td width="20%">Syntax</td>
<td width="16%">Examples</td>
<td>Description</td>
<th width="16%">Search Type</th>
<th width="20%">Syntax</th>
<th width="16%">Examples</th>
<th>Description</th>
</tr>
<tr>
<td>Normal Searches</td>
@ -72,9 +72,9 @@ Filters are set advanced search features that can be used in your search term. T
<table width="100%">
<tr style="font-weight:bold;">
<td width="25%">Syntax</td>
<td width="25%">Examples</td>
<td>Description</td>
<th width="25%">Syntax</th>
<th width="25%">Examples</th>
<th>Description</th>
</tr>
<tr style="font-weight:bold;">
<td colspan="3">Date Filters</td>

74
content/docs/user/wysiwyg-editor.md Normal file
View file

@ -0,0 +1,74 @@
+++
title = "Default Page Editor"
description = "Details on the standard Page editor in BookStack"
date = "2017-07-28"
type = "user-docs"
+++
The default editor in BookStack is a 'What You See Is What You Get' (WYSIWYG) editor.
The usage of this editor is similar to typical word-processing applications such as Word or Google Docs.
### Editor Shortcuts
The following shortcuts are available in the WYSIWYG Editor:
<table>
<thead>
<tr>
<th>Shortcut (Windows &amp; Linux/Mac)</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Ctrl+S</code> / <code>Cmd+S</code></td>
<td>Save Draft</td>
</tr>
<tr>
<td><code>Ctrl+B</code> / <code>Cmd+B</code></td>
<td>Bold</td>
</tr>
<tr>
<td><code>Ctrl+I</code> / <code>Cmd+I</code></td>
<td>Italic</td>
</tr>
<tr>
<td><code>Ctrl+U</code> / <code>Cmd+U</code></td>
<td>Underline</td>
</tr>
<tr>
<td>
<code>Ctrl+1</code> / <code>Cmd+1</code> <br>
<code>Ctrl+2</code> / <code>Cmd+2</code> <br>
<code>Ctrl+3</code> / <code>Cmd+3</code> <br>
<code>Ctrl+4</code> / <code>Cmd+4</code>
</td>
<td>
Header Large <br>
Header Medium <br>
Header Small <br>
Header Tiny
</td>
</tr>
<tr>
<td><code>Ctrl+5</code> / <code>Cmd+5</code><br><code>Ctrl+D</code> / <code>Cmd+D</code></td>
<td>Normal Paragraph</td>
</tr>
<tr>
<td><code>Ctrl+6</code> / <code>Cmd+6</code><br><code>Ctrl+Q</code> / <code>Cmd+Q</code></td>
<td>Blockquote</td>
</tr>
<tr>
<td><code>Ctrl+7</code> / <code>Cmd+7</code><br><code>Ctrl+E</code> / <code>Cmd+E</code></td>
<td>Code Block</td>
</tr>
<tr>
<td><code>Ctrl+8</code> / <code>Cmd+8</code><br><code>Ctrl+Shift+E</code> / <code>Cmd+Shift+E</code></td>
<td>Inline Code</td>
</tr>
<tr>
<td><code>Ctrl+9</code> / <code>Cmd+9</code></td>
<td>Callout <br>(Keep pressing to toggle through styles)</td>
</tr>
</tbody>
</table>