bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Started getting around page

Browse source
This commit is contained in:
Dan Brown 2022-12-12 15:01:02 +00:00
commit 0957057e66
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
1 changed files with 81 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

81
content/docs/user/getting-around.md Normal file
View file

@ -0,0 +1,81 @@
+++
title = "Getting Around & Finding Content"
date = "2022-12-12"
type = "user-doc"
slug = "getting-around"
+++
There's many ways to get around and find content within your BookStack instance
outside of following the core heirachy. The below details some of the main methods:
### Book Sidebar
The book sidebar is visible when within a book, and it reflects the full ordered heirachy
of the book you are within. If you are within a chapter, that chapter will be expanded by
default otherwise they will be collapsed & expandable with a click.
![View of the book sidebar showing child chapters and pages]()
### Next & Previous Links
When viewing a page or chapter, you'll find links below that content that allow you to
navigate between the next & previous content within the current book.
These links will reflect sibling content, or the next item within the parent level is no next/previous sibling exists.
![View of the next & previous actions when viewing a page]()
### Breadcrumbs
As you dive into your BookStack content you'll see breadcrumbs above
the main content area to reflect the parent path of the current item.
These will begin with the "Books" page unless
you've travelled through the "Shelves" view in which case this would begin with
the "Shelves" view and parent shelf.
![View of BookStack items, in a heirachy, with arrows in between]()
You can click on items to jump directly to those. You can also click the
arrows between items to search and jump to orthagonal content within
the structure heirachy.
![Breadcrumb view with an arrow clicked, showing a popover element listing BookStack pages and chapters]()
### Search
A major way to find and jump to content is by using search.
There's the global search input in the header, where you can search across all content in your instance:
![View of the header search bar with a search started and relevant items listed]()
When you start a global search, you'll get live feedback showing a preview of search results.
You can press enter or "View All" to view all relevant results on the search page.
On book and chapter views, you'll also find search inputs allowing you to search just within that book or chapter.
Find more information on our [Searching Content](/docs/user/searching/) page.
### Activity Lists
Many views, like that for a book or on the homepage, will show a list of
"Recent Activity", reflecting recent actions that have been made relevant to the
current context.
On these, you can click the name of the item within the listed activity to jump to that item.
![A list of user activity showing linked items names]()
### Recently Updated List
On the homepage you can find a "Recently Updated" list, showing the lasted pages
to have been created or updated.
You can press "View All" to view a larger paginated list.
![A card section with title "Recently Updates Pages" with a list of pages below]()
### Favourites
One way to easily recall content is by adding it to your favourites.
You can choose to favourite any shelf, book, chapter or page to add it
to your personal favourite collection.
You can then easily find your favourites, either as a list on the homepage
or via the "My Favourites" link in the header profile dropdown.
![A view of the "My Favourites" page, with the header profile dropdown menu showing containing a link to "My Favourites"]()