]> BookStack Code Mirror - website/commitdiff
Added organising-content page and updated content overview
authorDan Brown <redacted>
Sun, 8 Jan 2017 16:30:53 +0000 (16:30 +0000)
committerDan Brown <redacted>
Sun, 8 Jan 2017 16:30:53 +0000 (16:30 +0000)
public/images/docs/book-sort.png [new file with mode: 0644]
public/images/docs/page-move-menu.png [new file with mode: 0644]
resources/docs/user/content-overview.md
resources/docs/user/organising-content.md [new file with mode: 0644]
resources/sass/styles.scss
resources/views/base.blade.php
resources/views/docs/user-sidebar.blade.php

diff --git a/public/images/docs/book-sort.png b/public/images/docs/book-sort.png
new file mode 100644 (file)
index 0000000..6690352
Binary files /dev/null and b/public/images/docs/book-sort.png differ
diff --git a/public/images/docs/page-move-menu.png b/public/images/docs/page-move-menu.png
new file mode 100644 (file)
index 0000000..f6407cb
Binary files /dev/null and b/public/images/docs/page-move-menu.png differ
index e15fe5884d7911dc781a6851ca4edb1d6f8425d5..b6c1a1dce56349c3049bce308705621503e36da5 100644 (file)
@@ -2,6 +2,18 @@
 
 The principles of storing information within BookStack is based of the ideas of a normal stack of books. Just like normal books, BookStack books can contain chapters and pages. You start off by creating a book which acts as the highest level of categorisation. Ideally you'd have separate books for separate topics. 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.
 
+### Default Colour Coding
+
+Books, chapters and pages have set colour coding in BookStack to ensure they are easily identifiable. The below examples show the default color scheme. Note that this may be overridden by your administrator.
+
+ <span style="color:#009688;line-height:12px;"><svg fill="#009688" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"></path><path d="M18 2H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zM6 4h5v8l-2.5-1.5L6 12V4z"></path></svg> <span style="position:relative;top:-6px;">Books</span></span>
+&nbsp;
+<span style="color:#ef7c3c;"><svg fill="#ef7c3c" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M4 6H2v14c0 1.1.9 2 2 2h14v-2H4V6z"></path><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M20 2H8c-1.1 0-2 .9-2 2v12c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zm0 10l-2.5-1.5L15 12V4h5v8z"></path></svg> <span style="position:relative;top:-6px;">Chapters</span></span>
+&nbsp;
+<span style="color:#0288D1;"><svg fill="#0288D1" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"></path><path d="M14 2H6c-1.1 0-1.99.9-1.99 2L4 20c0 1.1.89 2 1.99 2H18c1.1 0 2-.9 2-2V8l-6-6zm2 16H8v-2h8v2zm0-4H8v-2h8v2zm-3-5V3.5L18.5 9H13z"></path></svg> <span style="position:relative;top:-6px;">Pages</span></span>
+&nbsp;
+<span style="color:#9A60DA;"><svg fill="#9A60DA" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="M0 0h24v24H0z" fill="none"></path><path d="M14 2H6c-1.1 0-1.99.9-1.99 2L4 20c0 1.1.89 2 1.99 2H18c1.1 0 2-.9 2-2V8l-6-6zm2 16H8v-2h8v2zm0-4H8v-2h8v2zm-3-5V3.5L18.5 9H13z"></path></svg> <span style="position:relative;top:-6px;">Draft Pages</span></span>
+
 ### Starting Out
 
 When you start out with your new BookStack instance you can organise things in two ways; You can plan out your book/chapter/page structure or you can let things grow naturally over time. If you know or already have the content which will be going into BookStack then it's probably best to plan early otherwise, if you're starting from scratch, you'll want to let everything find it's own place.
diff --git a/resources/docs/user/organising-content.md b/resources/docs/user/organising-content.md
new file mode 100644 (file)
index 0000000..81054c7
--- /dev/null
@@ -0,0 +1,21 @@
+# Organising Content
+
+Once your BookStack instance starts to grow you will find that you may want to re-organise your content. Within BookStack there are two options for moving content around; Either you can move pages and chapters individually or you can sort entire books.
+
+Note that to move content you will need to have 'edit' permission for both the content being moved and the parent it's being moved into.
+
+### Moving Single Books & Chapters
+
+Books 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 overflow menu, found on the right-hand side of the top toolbar:
+
+![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.
+
+### Sorting Books
+
+The 'Book Sort' interface allows you to move multiple pages and chapters with ease in a simple drag and drop interface. To sort a book simply go to the book and select 'Sort' in the overflow menu (3 vertical dots found next to the edit button) at the top right of the page and you will be directed to the sort view:
+
+![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.
\ No newline at end of file
index 17eb04b613fb0d40a3bdd2a838fd14b4618fe2b3..57e89c281dc29e0dbe1b6c05d084d660342b5e41 100644 (file)
@@ -238,6 +238,10 @@ input[type=text] {
       fill: $primary;
     }
   }
+  img {
+    border: 1px solid $primary;
+    border-radius: 3px;
+  }
 }
 
 .sidebar, .docs-index {
index 9fb3b875bcb01756db429619e94d92081e0f16d8..bc1c9362eb6159258b0defb84024ad71db06b55e 100644 (file)
 <body>
 
     <script>
-    // Standard Google Analytics Stuff
-    (function(i, s, o, g, r, a, m) {
-        i['GoogleAnalyticsObject'] = r;
-        i[r] = i[r] || function() {
-            (i[r].q = i[r].q || []).push(arguments)
-        }, i[r].l = 1 * new Date();
-        a = s.createElement(o),
-            m = s.getElementsByTagName(o)[0];
-        a.async = 1;
-        a.src = g;
-        m.parentNode.insertBefore(a, m)
-    })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
-
-    ga('create', 'UA-61486258-4', 'auto');
-    ga('send', 'pageview');
+        if (window.location.href.toLowerCase().indexOf('bookstackapp.com') !== -1) {
+            // Standard Google Analytics Stuff
+            (function(i, s, o, g, r, a, m) {
+                i['GoogleAnalyticsObject'] = r;
+                i[r] = i[r] || function() {
+                        (i[r].q = i[r].q || []).push(arguments)
+                    }, i[r].l = 1 * new Date();
+                a = s.createElement(o),
+                    m = s.getElementsByTagName(o)[0];
+                a.async = 1;
+                a.src = g;
+                m.parentNode.insertBefore(a, m)
+            })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
+
+            ga('create', 'UA-61486258-4', 'auto');
+            ga('send', 'pageview');
+        }
     </script>
 
     <header id="header">
index 724b5241c0df1748951612db69f10c8d9eba023f..667fe2f578787876f2249f93fd4b84dee52d195c 100644 (file)
@@ -2,4 +2,5 @@
 <h4>Getting Started</h4>
 <ul>
        <li><a href="{{ docLink('user/content-overview') }}">Content Overview</a></li>
+       <li><a href="{{ docLink('user/organising-content') }}">Organising Content</a></li>
 </ul>