The <Dashboard> provides a variety of features that help you manage documents.
Sidebar
The sidebar menu on the left side of the screen is divided into an upper part and a lower part.
Upper sidebar menu
1Document Explorer: Shows the document list.
2Search in Content: Searches document content in the left side panel.
3Menu: Shows the menus in the top “menu bar”.
4Notifications: Notifies you of events such as changes, comments, and feedback in the documents you watch.
5Favorites: Shows your favorite documents.
6Recently Opened Documents: Shows the documents you opened recently.
7Task: Shows the tasks that have been created. You can also create a task right away. Only users with the “Write & Read” role can see it.
Lower sidebar menu
7Console: Only users with the “Administrator” role can see it. See Console.
8Help: Opens the help on the ManualWorks website.
Watching and Notifications
“Watch” notifies you when the content of a document you watch changes and tells you what changed. Documents you create are watched by default. For documents created by others, you must choose to watch each one.
To watch a document, click the <1Watch> icon to the right of the document title on the document details screen. Click the icon again to stop watching the document.
You receive notifications when the content of a watched document changes and when comments and feedback are created, changed, or deleted. Configure the details in the notification settings of My Profile.
Set the notification interval in the Scheduler (
com.threerabbitz.base.tool.event.EventCreatorScheduler). The default is 10 minutes.If a mail server is configured, notifications are also sent by email. For details, see Configuring Mail.
Check who is watching a document.
Click the <2View Details> link in the “Access Control” panel of the document details screen.
Check the 3watch status of each user.
Sending Notifications
Send notification messages from the “Notifications” panel of the dashboard. You need the “Administrator” role. The sender also receives the notification message.
Notification settings do not apply to notifications sent from this menu.
Follow these steps to send a notification message to users. If you configured mail, an email is also sent.
Click the 1Notifications button in the sidebar.
In the “Notifications” panel, click the <2Send Notification> link.
Enter the subject and content, and select the users who will receive the notification.
Click the button.
Check the following in the Notifications panel.
Click the 3content to go to the related screen.
Click the 4<View Details> link to see the item in a modal window.
Unread notifications are marked as shown in 5. Click the <Mark as Read> link to remove the mark.
To see only unread notifications, turn on the 6toggle.
Click the <7Mark All as Read> link to mark all notifications as read.
The Scheduler (com.threerabbitz.base.tool.event.EventClearScheduler) deletes notifications periodically. Read notifications are deleted after 7 days, and unread notifications after 14 days. Use other means to keep content you need to preserve.
Favorites
To add a favorite, click the <Favoritesstar> icon next to the 1document title on the document details screen or next to a 2chapter title in the table of contents. Click the icon again to remove the favorite.
Add a document to favorites.
Add a chapter to favorites.
Click the “Favorites” button in the sidebar to see your favorite documents and chapters.
3Click the button to show the favorites list in the side panel.
4Click a document title to go to the document details screen.
5Click a chapter title to open the chapter in the editor.
Recently Opened Documents
Check the list of recently opened editors on the dashboard.
1Click the button to show the list of recently opened documents in the side panel.
2Click a document title to go to the document details screen.
3Click a chapter title to open the editor.
Searching for Documents
Search for documents in the following ways. Searches are case-sensitive for English letters.
1Search by document type.
2Search the documents in the document list by the following items.
- Title
- Subtitle
- Edition
- Author
3Search for documents you watch.
Finding and Replacing Document and Chapter Titles
Find and replace document and chapter titles in the Console.
You need the “Administrator” role. Only books, short documents, and blogs for which you have “Owner” access are included.
In the <Dashboard> sidebar, click the 1Console button to run the console.
Run the following command. Enter the string to find in the
toption.
find-title -t Roboto
Click the <2Replace> link to replace the title.
Grouping Documents with Labels
Use labels to group multiple documents together or to make specific documents easy to find.
Click a 1label to show only the documents with that label.
For details, see Labels.