Basic concepts

# 🎊 Basic Concepts

The following introduces some basic concepts of the MrDoc system to facilitate users' use and understanding of the system.

## Document

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

Documents are divided into the following types:

- Online text document
	- Markdown document
	- Rich text document
- Online spreadsheet document
- Hyperlink document
- Shortcut document
- Mind map document
- Drawio document
- Drawing board document
- Office/PDF document

```mindmap
# Document Types
- Online text document
	- Markdown document
	- Rich text document
- Online spreadsheet document
- Hyperlink document
- Mind map document
- Drawio document
- Drawing board document
- Shortcut document (content links to other documents)
- Office/PDF document
```

Different types of documents are suitable for different writing needs. You can choose different types to create documents according to your needs.

### Hierarchical Documents

MrDoc does not have concepts such as project directories or folders.

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

### Document Permissions

Document permissions follow the permissions of the project. The Pro edition can further control documents based on project permissions.

```mindmap
# Document Permissions
- None (follows project)
- Visible with password
- Visible after login
- Visible to specified users
- Visible to specified user groups
```

## Project

A project is a collection of documents. All documents must be stored under a specified project. A project is equivalent to a book or a knowledge base.

Permission control over projects is the most basic permission control in MrDoc.

### Project Permissions

Project permissions are divided into **collaboration permissions** and **browsing permissions**.

**Collaboration permissions** are used for non-project creators to create documents within a project, mainly for team collaboration and knowledge base co-construction.

```mindmap
# Collaboration Permissions
- Basic collaboration (can only create, modify, and delete documents created by oneself)
- Advanced collaboration (can create documents and modify all documents within the project)
- Specified editing permission (can edit specified documents and browse all documents within the project)
- Edit-only permission (can only edit specified documents and cannot browse other documents within the project)
```

**Browsing permissions** are used for access control over browsing documents within a project. Objects with collaboration permissions are not subject to browsing permission access restrictions.

```mindmap
# Browsing Permissions
- Public
- Private
- Restricted
	- Visible with access code
	- Visible after login
	- Visible to specified users
	- Visible to specified user groups
```

## Material

Materials in MrDoc include **images** and **attachments**.

### Attachment Formats

Attachments support uploading in `zip` format by default. You can configure the whitelist of attachment formats in the site settings of the backend management. In this way, file formats within the whitelist are allowed to be uploaded as attachments.

### Attachment Size

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

> d Please note that if tools such as Nginx are used when deploying MrDoc, make sure that the maximum allowed request size value of tools such as Nginx is greater than or equal to the configured maximum allowed upload size for attachments.

## User

### User Roles
The user roles in MrDoc are divided into ordinary users and administrator users. Administrator users can access the backend management page and perform related operations.

### User Permissions

User write permissions are subdivided into:

- Project
- Document
- Image
- Attachment

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

As the name implies, users with read-only permissions can only browse documents (provided they have the specified document browsing permission) and do not have permission to create and modify documents, projects, or upload images and attachments.

Users with read-write permissions can perform the corresponding write permission operations. For specific configuration, see Backend Management - Site Settings - Registration and User Configuration.

You can also set the read-write permissions for a specified user individually in Backend Management - User Management.

@[frag](id=8 title=Pro Edition Guide - General)