Readin CMS manual

Revision #11 - Published 15/05/2024 - View current version

Summary

The Readin CMS manual provides comprehensive guidance on using the Readin content management system, detailing its structure and various functionalities. It covers topics such as document management, where users can upload new documents, access properties, manage versions, and handle metadata.

The manual also explains how to manage blogs, the library, link checking, analytics, and settings, which include language options and appearance customization. Additionally, it discusses user access levels, storage solutions, and the integration of AI for generating revision notes.

The manual is structured to mirror the CMS's menu order for ease of navigation.

Show summary

Metadata

Title:
Readin CMS manual

Revisions (22)

New revision
- Introduction
  The phrase "different menus appear in the left-hand Table of Content (TOC)" has been changed to "items appear in the left-hand menu".
- Documents
  Select Version (or Create New):
  The option "Create new version" has been rephrased to "Create new draft".
  Added an explanation about updating compound documents when child documents are modified.
  Select Action - Publish / Update: Clarification that compound documents require all child documents to be published before publishing the compound.
- New Document
  Compound: Rephrased instructions for creating a compound document and removed detailed steps about rearranging order and updating status.
- Features
  Simplified explanation about customizing feature presets and removed detailed dependency explanation.
View this version
10/12/2024
New revision
The document outlines several updates and changes made to various sections and content. Key points include:
- Table of Contents
  The "Language" section was repositioned to follow "Appearance".
  The subsection under "Settings" was renamed from "General" to "Features".
- Content Changes
  Introduction, New Document, Library
  The acronym "TOC" was expanded to "Table of Contents (TOC)" or "Table of Content (TOC)" as applicable.
  Settings - General
  The description for "Site title" was updated to reflect its display in the browser tab.
  Settings - Features (new section)
  This section allows control and configuration of the main features of the Readin site through presets that affect visible menu items in the TOC. Changes require saving to update the TOC.
  Features are categorized into General, User, and Document groups. Customization is possible, and changes may prompt dependency adjustments.
  If a preset conflicts with disabled features, it defaults to “Custom”.
  Appearance
  The sentence regarding initial front page selection was reformulated. Options for visibility based on user login status were removed and replaced with a “Default tab” selection. The “Show for” setting for AI Assistant is controlled on the “Features” page.
View this version
06/12/2024
New revision
- Table of Content
  Added section: Access under Documents
  New subsections under Access:
  Other types of access
  Registered users with access
  Added section: Workspace and Public SSO Providers under Access
- Documents - Access
  Other types of access: New subsection detailing document availability for registered and unregistered users.
  Registered users with access: New subsection listing users with access to the document, including their name, email, role, and site affiliation.
- Analytics
  The order of sections changed; "External analytics" now precedes simple analytical data.
  "Aggregated reads" renamed to "Total".
  "Unique reads" renamed to "Unique".
  "Annotations" renamed to "Comments".
  Addition of "Highlights" as a new data point for each document.
- Access
  Workspace: New section showing domain, workspace names, and external token information.
  Public SSO Providers: New section detailing public single sign-on options for user login.
- Users
  "Content role" replaced by "Site(s)" indicating active sites for the user.
  Description updated: Clicking on a user now opens a window with user details and editing options.
  Addition of a pulldown list "View document access" showing documents the user can access.
View this version
20/11/2024
New revision
Settings - Front page
- You can now add "AI Assistant" as one of the tabs displayed on the library page instead of using Ai Assistant as the initial front page.
View this version
23/10/2024
New revision
- Analytics
Added a new section titled "External analytics."
- Explanation of how to add tracking IDs for Google Analytics and Hotjar.
  Provided a link to a guide on setting up Google Analytics and obtaining the tracking ID.
View this version
12/09/2024
New revision
Renamed all references to CMS as Readin Admin Page

View this version
26/08/2024
New revision
Removed option to set metadata as "Private". This is now done by not selecting any of the "Display locations" instead.

View this version
22/08/2024
New revision
Added new subsection: History under Accessing document properties.
- it explains how the History view in the CMS gets updated whenever something is modified in relation to the current document.
View this version
21/08/2024
New revision
Settings
- Added new submenu: "Front Page" where you can specify the initial front page for the site.
- Library page settings added where you can control the display of tabs on the library page.
- Added a content editor for the Information tab on the library page. This is replacing the old "About" editor previously found under the "Appearance" submenu.
View this version
20/08/2024
New revision
Updated the section regarding the Access tab.
- Renamed Front Page to Global.
- Removed Search and AI Assistant as separate access items. Search and AI access will from now on follow the settings for Content.
View this version
09/08/2024
New revision
- Documents
  Select action - Personals
Now lists "Personals” divided into four sub-categories in the dropdown, letting you directly show all the annotations, bookmarks, followers or highlights associated with the current document."
- Library
  Document Organizer
Explaining how you can narrow down the list of documents by using the “search” field or the new “filter” field. You may also combine the two methods to achieve even more specific filtering.
View this version
27/06/2024
New revision
Improvements:
- Restructure of the document properties tab, making it more intuitive and accessible.
- Introduction of a dropdown menu under the main "Document" tab for easier navigation between versions.
New features:
- Integration of AI to generate revision notes, simplifying the process of documenting changes.
- Introduction of a "Summary" feature, allowing authors to provide a brief overview of the document.
- Implementation of "Link access only" and "Delete draft version" options for enhanced document management.
View this version
15/05/2024
Added AI Assistant
Added sections regarding the AI Assistant

View this version
05/04/2024
New revision
- Under "Metadata" in section "Documents" text has been updated with the change in how metadata is organized. All metadata are now grouped into 1 or more "Meta Profiles".
- The topic "Metadata builder" under section "Settings" has been updated and rearranged:
  All metadata are now by default assigned to one "Meta Profile" named "General"
  You can now specify default values for metadata keys. Helps applying metadata values to documents in a more effective manner.
View this version
14/03/2024
New features
Filter document view based on metadata and/or free text search is a requested feature that allows filtering documents in the document overview in Readin CMS. Filtering is done based on metadata and/or free text search. If you have many documents, you can now filter based on, for example, type, document owner, or keywords.
We have added show/hide columns in Readin CMS. Now you can choose which columns to display in the document overview, and you can sort based on columns, such as sorting documents that contain read confirmation.
In Readin CMS, you can now use a combination of drag and drop and automatic construction to create an organized and user-friendly document library:
1. Drag and drop: You can easily drag and drop documents into the library. This is a quick and easy way to organize your documents.
2. Automatic construction: You can automatically build your library using metadata. Metadata is information about your documents, such as type, category, and subject. When you add a document, Readin CMS can use the metadata to place it in the correct category and folder.
View this version
15/02/2024
Ny revisjon
"Document organizer" under "Library" has been rewritten with how the libaray (TOC) now can be built manually with folders and documents, or automatically with Metadata, or even as a combination of the two techniques.
Some restructuring, minor corrections and clarifications.
View this version
02/02/2024
New revision
Settings --> appearance. Front page "Initial view" explained and some other minor changes.

View this version
12/09/2023
Ny revisjon
Mindre endringer.

View this version
16/08/2023
Ny revisjon
Mindre endringer.

View this version
04/08/2023
Ny revisjon
Mindre endringer.

View this version
03/08/2023
Ny revisjon
Store endringer pga. store endringer i CMS

View this version
04/07/2023
Første rev
Første revisjon

View this version
21/09/2022

Summary

Metadata

Revisions (22)

Comments (0)

Highlights (0)

Bookmarks (0)

Questions (0)