🎊 Basic Concepts

Below is an introduction to some basic concepts of the MrDoc documentation system to facilitate users' understanding and usage of the system.

## Document

A document is the most fundamental component of MrDoc. A document is similar to a chapter in a book.

Documents are categorized into the following types:

- Online Text Document  
  - Markdown Document  
  - Rich Text Document  
- Online Spreadsheet Document  
- Hyperlink Document  
- Shortcut Document  
- OnlyOffice Document

```mindmap
# Document Types
- Online Text Document
	- Markdown Document
	- Rich Text Document
- Online Spreadsheet Document
- Hyperlink Document
- Shortcut Document (Content links to other documents)
- OnlyOffice Document
```

Different types of documents cater to different writing needs. You can choose the appropriate type to create documents based on your requirements.

### Hierarchical Documents

MrDoc does not use concepts such as collection directories or folders.

If you need to implement similar functionality within a collection, the correct approach is to create a new document and set it as the parent document of other documents.

### Document Permissions

Document permissions follow the permissions of the collection. The Professional Edition allows further control over document permissions on top of the collection permissions.

```mindmap
# Document Permissions
- None (Follows Collection)
- Password Visible
- Login Required
- Visible to Specified Users
- Visible to Specified User Groups
```

## Collection

A collection is a set of documents. All documents must be assigned to a collection for storage. A collection is equivalent to a book or a knowledge base.

Permission control for collections is the most fundamental permission control in MrDoc.

### Collection Permissions

Collection permissions are divided into **Collaboration Permissions** and **Viewing Permissions**.

**Collaboration Permissions** are used for non-collection creators to author documents within the collection, primarily for team collaboration and knowledge base co-creation.

```mindmap
# Collaboration Permissions
- Basic(own documents)
  -  create,
  - modify
  - delete
- Advanced
  - create documents
  - modify all documents
- Specified Edit Permissions
  - edit specified documents
  - view all documents
- Edit-Only Permissions
  - only edit specified document
  - cannot view other document
```

**Viewing Permissions** are used to control access to viewing documents within the collection. Entities with collaboration permissions are not restricted by viewing permissions.

```mindmap
# Viewing Permissions
- Public
- Private
- Restricted
	- Access Code Required
	- Login Required
	- Visible to Specified Users
	- Visible to Specified User Groups
```

## Assets

MrDoc assets include **Images** and **Attachments**.

### Attachment Formats

By default, attachments support uploading in `zip` format. You can configure a whitelist of attachment formats in the site settings of the backend management. Files in the whitelist formats will be allowed as attachments.

### Attachment Size

Attachments are restricted to files smaller than `50MB` by default. You can configure the maximum allowed upload size for attachments in the site settings of the backend management.

> ⚠️ Please note: If tools like Nginx are used when deploying MrDoc, ensure that the maximum allowed request size in Nginx (or similar tools) is greater than or equal to the configured maximum allowed upload size for attachments.

## User

### User Roles

MrDoc user roles are divided into regular users and administrator users. Administrator users can access the backend management page and perform related operations.

### User Permissions

User permissions are divided into read-only permissions and read-write permissions.

As the names suggest, users with read-only permissions can only browse documents (provided they have the necessary document viewing permissions) and do not have the permissions to create or modify documents, collections, or upload images and attachments.

Users with read-write permissions can perform corresponding write operations. For specific configurations, refer to the backend management - site settings.