diff --git a/docs/user/files-and-folders/img/markdown-editor/editor-open.png b/docs/user/files-and-folders/img/markdown-editor/editor-open.png deleted file mode 100644 index 829e599e0..000000000 Binary files a/docs/user/files-and-folders/img/markdown-editor/editor-open.png and /dev/null differ diff --git a/docs/user/files-and-folders/img/markdown-editor/slash-menu.png b/docs/user/files-and-folders/img/markdown-editor/slash-menu.png deleted file mode 100644 index cb799f6e7..000000000 Binary files a/docs/user/files-and-folders/img/markdown-editor/slash-menu.png and /dev/null differ diff --git a/docs/user/files-and-folders/img/text-editor/code-block.png b/docs/user/files-and-folders/img/text-editor/code-block.png new file mode 100644 index 000000000..3167436e3 Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/code-block.png differ diff --git a/docs/user/files-and-folders/img/text-editor/collaboration.png b/docs/user/files-and-folders/img/text-editor/collaboration.png new file mode 100644 index 000000000..c6761d7a1 Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/collaboration.png differ diff --git a/docs/user/files-and-folders/img/text-editor/editor-overview.png b/docs/user/files-and-folders/img/text-editor/editor-overview.png new file mode 100644 index 000000000..83e610de9 Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/editor-overview.png differ diff --git a/docs/user/files-and-folders/img/text-editor/find-replace.png b/docs/user/files-and-folders/img/text-editor/find-replace.png new file mode 100644 index 000000000..115f55fab Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/find-replace.png differ diff --git a/docs/user/files-and-folders/img/text-editor/formatting-toolbar.png b/docs/user/files-and-folders/img/text-editor/formatting-toolbar.png new file mode 100644 index 000000000..5e964f140 Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/formatting-toolbar.png differ diff --git a/docs/user/files-and-folders/img/text-editor/insert-image.png b/docs/user/files-and-folders/img/text-editor/insert-image.png new file mode 100644 index 000000000..1b6ff7ee4 Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/insert-image.png differ diff --git a/docs/user/files-and-folders/img/text-editor/insert-link.png b/docs/user/files-and-folders/img/text-editor/insert-link.png new file mode 100644 index 000000000..47753ed8b Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/insert-link.png differ diff --git a/docs/user/files-and-folders/img/text-editor/insert-table.png b/docs/user/files-and-folders/img/text-editor/insert-table.png new file mode 100644 index 000000000..da40e70b8 Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/insert-table.png differ diff --git a/docs/user/files-and-folders/img/text-editor/mentions.png b/docs/user/files-and-folders/img/text-editor/mentions.png new file mode 100644 index 000000000..8130c8c61 Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/mentions.png differ diff --git a/docs/user/files-and-folders/img/text-editor/note-formatting.png b/docs/user/files-and-folders/img/text-editor/note-formatting.png new file mode 100644 index 000000000..3b2f715de Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/note-formatting.png differ diff --git a/docs/user/files-and-folders/img/text-editor/slash-menu.png b/docs/user/files-and-folders/img/text-editor/slash-menu.png new file mode 100644 index 000000000..bcab2830d Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/slash-menu.png differ diff --git a/docs/user/files-and-folders/img/text-editor/table-of-contents.png b/docs/user/files-and-folders/img/text-editor/table-of-contents.png new file mode 100644 index 000000000..9ce0f28a8 Binary files /dev/null and b/docs/user/files-and-folders/img/text-editor/table-of-contents.png differ diff --git a/docs/user/files-and-folders/index.md b/docs/user/files-and-folders/index.md index ec12f202e..e5c126a4b 100644 --- a/docs/user/files-and-folders/index.md +++ b/docs/user/files-and-folders/index.md @@ -22,8 +22,9 @@ This section covers common day-to-day tasks such as creating and moving content, - [Delete and restore items from the trash](./delete-restore.md) Remove files and folders and restore them later if needed. -- [Editing Markdown files](./markdown-editor.md) - Edit `README.md` and other Markdown files directly in OpenCloud with formatting suggestions. +- [Text Editor](./text-editor.md) + Create and edit Markdown files, OpenCloud Notes, and plain text files directly in your browser. Format content and collaborate on documents in real time. + - [README files in folders](./readme-files.md) Add a `README.md` file to a folder so OpenCloud renders it above the file list. diff --git a/docs/user/files-and-folders/markdown-editor.md b/docs/user/files-and-folders/markdown-editor.md deleted file mode 100644 index f62e023c7..000000000 --- a/docs/user/files-and-folders/markdown-editor.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: markdown-editor -sidebar_position: 40 -title: Editing Markdown Files -description: Learn how to edit Markdown files with the OpenCloud Tiptap editor. ---- - -# Editing Markdown Files - -OpenCloud uses a Tiptap-based Markdown editor for files such as `README.md` and other `.md` files. The editor helps you write and format content even if you do not know Markdown syntax well. - -## How the Editor Works - -When you open a Markdown file, OpenCloud shows it in the editor so you can write and update the file directly in the browser. - -Markdown editor open on a README file - -You can add headings, lists, links, quotes, code, and other common formatting without leaving the file view. - -As you edit, OpenCloud shows the Markdown content rendered right away so you can immediately see how the file will look. - -The editor also supports inserting images and creating tables, which makes it easier to build richer Markdown files directly in OpenCloud. - -## Use the Slash Shortcut - -Type `/` in a new line to open the formatting menu. - -The menu gives you a quick overview of the available formatting options and lets you insert them without memorizing every shortcut. - -Slash menu in the Markdown editor - -This is especially helpful when you want to insert formatting quickly while keeping your hands on the keyboard. - -## Use the Formatting Toolbar - -Use the formatting toolbar above the editor to insert common Markdown elements. - -Click the `Heading` button to choose a heading level or use the other buttons for bold, italic, lists, code, images, and tables. - -This is especially helpful if you want to format content quickly without memorizing every Markdown shortcut. - -## Supported Formatting - -The Markdown editor supports common formatting options for all Markdown files. You can use the toolbar or the slash menu to insert: - -- headings -- bold and italic text -- bullet and numbered lists -- quotes -- inline code and code blocks -- links -- images -- tables - -## Good To Know - -- The editor works for Markdown files such as `README.md`. -- You can use the formatting menu to build structured content step by step. -- The file stays a normal Markdown file, so it can still be used outside OpenCloud. - -When the file is saved, the Markdown content is stored in the same `.md` file and can be rendered wherever Markdown is supported. diff --git a/docs/user/files-and-folders/text-editor.md b/docs/user/files-and-folders/text-editor.md new file mode 100644 index 000000000..776e28b23 --- /dev/null +++ b/docs/user/files-and-folders/text-editor.md @@ -0,0 +1,162 @@ +--- +id: text-editor +sidebar_position: 40 +title: Text Editor +description: Create, format, collaborate on, and save text documents and notes in OpenCloud. +--- + +# Using the Text Editor + +OpenCloud 8.0 and later includes a Tiptap-based editor for working with supported text files directly in your browser. You can create and format Markdown documents and OpenCloud Notes without installing additional software. With collaborative editing enabled, several people can also work on the same document in real time. + +## Create or Open a Document + +To create a document: + +1. Open the folder or Space where you want to store the document. +2. Select `New`. +3. Select `Note` to create an `.ocnote` file or `Markdown file` to create an `.md` file. +4. Enter a file name and confirm the creation. + +The new document opens in the text editor. + +To open an existing document, select the file in the file list. If the text editor is not the default application for that file, open its context menu and select `Open with...` and then `Text Editor`. + +OpenCloud text editor showing a formatted Markdown document + +:::note +You need permission to edit the file. If you only have view permission, you can follow changes made by others but cannot change the document. +::: + +## Choose a File Format + +Choose the format based on how you want to use the document. + +| Format | Use it for | Formatting | +| :------------------------- | :------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------- | +| Markdown (`.md`) | Portable documents that you also want to use with external Markdown tools | Headings, emphasis, lists, quotes, links, images, tables, and code | +| OpenCloud Note (`.ocnote`) | Rich notes that you primarily edit in OpenCloud | Markdown-style features plus font size, text and background colors, line height, alignment, underline, subscript, and superscript | +| Plain text (`.txt`) | Unformatted text, logs, or simple notes | Plain text without rich formatting; search, replace, and printing remain available | + +An `.ocnote` file is an OpenCloud rich-text format stored as text-based JSON. It is not a standard Markdown format. + +OpenCloud Note with rich text formatting and the text color menu open + +## Format Your Content + +Use the formatting toolbar to undo or redo changes, format text, create lists, and insert content. In narrow windows, actions that do not fit move into `More actions`. + +Formatting toolbar in the OpenCloud text editor + +To format existing text: + +1. Select the text or place the cursor in the block you want to change. +2. Use `Turn into` to choose a paragraph, heading, quote, or code block. +3. Use the toolbar actions for bold, italic, strikethrough, or a list as needed. + +### Use the Slash Menu + +Type `/` at the beginning of a line to open the slash menu. Start typing the name of an action to filter the menu, then select an item such as a heading, list, quote, code block, link, image, or table. + +Slash menu with formatting and insertion actions + +When you hover next to a content block, use `Add content` to insert a block after it. On a desktop device, use `Drag to move` to rearrange blocks. + +### Insert a Link + +1. Select the text that should become a link, or place the cursor where you want to add one. +2. Select `Link` in the toolbar or slash menu. +3. Enter the destination URL and link text. + +Link editor with fields for the URL and link text + +### Insert Code + +Use `Inline code` for code within a sentence. For multiple lines, select `Code block` from `Turn into` or the slash menu. The editor highlights supported languages, detects the language when possible, and also lets you choose a language. + +Code block with syntax highlighting and a language selector + +## Insert Images and Tables + +### Insert an Image + +1. Place the cursor where you want the image. +2. Open `Insert image` in the toolbar, or type `/image`. +3. Choose one of the available options: + - `Image from file` uploads an image from your device. + - `Image from URL` inserts an image from an `http://` or `https://` address. + - `Insert from cloud` selects an image already stored in OpenCloud. This option is not available from a public link. +4. After insertion, select the image and use its resize handles to adjust its size. + +Slash menu showing the supported image insertion options + +### Insert a Table + +1. Place the cursor where you want the table. +2. Select `Create a table` in the toolbar or slash menu. +3. Choose the required number of rows and columns. +4. Select a cell to open the table controls. + +The table controls let you add or remove rows and columns, toggle the header row, or delete the table. + +Table inserted into a document + +## Find and Navigate Content + +### Find and Replace Text + +Open `Search and replace` from the toolbar, or press `Ctrl + F` (`Cmd + F` on macOS). Enter the text to find and, if needed, replacement text. You can match the letter case or whole words only. + +Find and replace interface in the OpenCloud text editor + +### Navigate with the Table of Contents + +Markdown and `.ocnote` documents provide a table of contents generated from their headings. Open the `Outlines` panel to see the document structure. Select a heading to jump to it; the active entry follows your position as you scroll and the list updates when headings change. + +Markdown document with the Outlines table of contents open + +## Collaborate on Documents + +Real-time collaboration is available for Markdown and `.ocnote` files. When several users open the same document, changes appear in their editors immediately. The toolbar shows active participants, and colored cursors indicate where they are working. + +Users with edit permission can change the document. Users with view permission can follow the session without seeing editing controls. + +Markdown document with two active participants and Margaret Hamilton's cursor + +### Mention Another User + +In a Markdown or `.ocnote` document, type `@` and select a user from the suggestion list. Only users who can access the document are offered. The mention notification is sent after the document is saved and follows the configured notification settings. + +Mentions are not available through public links. + +Mention suggestion menu showing Margaret Hamilton + +:::note +Real-time collaboration requires the Yjs service. Administrators can find deployment details in [Collaborative Editing with the Yjs Server](../../admin/configuration/collaborative-editing.md). +::: + +Collaboration has the following limitations: + +- Public links do not join a collaborative session. A user with write access can still edit and save, but changes do not appear in other open editors in real time. +- Collaborative editing is disabled for files in end-to-end encrypted vaults. +- Source mode is read-only while collaboration is active because source changes cannot be merged into the shared document. + +## Save Your Changes + +Changes in the editor and changes saved to the file are separate: + +- During a collaborative session, your edits synchronize with the other participants immediately. +- The file is updated when a participant selects `Save`, presses `Ctrl + S` (`Cmd + S` on macOS), or periodic autosave runs. +- The autosave interval is configured by the administrator and is shown in the editor when autosave is enabled. + +If another application, such as a desktop sync client, changes the file while it is open, OpenCloud notifies the editor immediately. If you have no unsaved changes, the editor loads the newer file. If you have unsaved work, keep it by selecting `Save as`, or reload the page to discard it and open the external version. + +Each successful save updates the regular OpenCloud file. Previous states are therefore available according to the normal [file versioning](./versions.md) rules. + +## Good to Know + +- Markdown files remain compatible with external Markdown editors, although rendering details can differ between applications. +- `.ocnote` preserves rich formatting that Markdown cannot represent and is intended for use with OpenCloud's editor. +- Code blocks provide syntax highlighting for common programming and configuration languages. +- Select `Print` to open the system print dialog. Depending on your operating system, the dialog may also offer `Save as PDF`; this creates a local file and does not save a PDF in OpenCloud. +- To display a `README.md` above a folder's file list, see [README Files in Folders](./readme-files.md). diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/markdown-editor/slash-menu.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/markdown-editor/slash-menu.png deleted file mode 100644 index 22b8a91e4..000000000 Binary files a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/markdown-editor/slash-menu.png and /dev/null differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/code-block.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/code-block.png new file mode 100644 index 000000000..3167436e3 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/code-block.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/collaboration.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/collaboration.png new file mode 100644 index 000000000..79b466bcd Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/collaboration.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/markdown-editor/editor-open.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/editor-open.png similarity index 100% rename from i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/markdown-editor/editor-open.png rename to i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/editor-open.png diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/editor-overview.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/editor-overview.png new file mode 100644 index 000000000..83e610de9 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/editor-overview.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/find-replace.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/find-replace.png new file mode 100644 index 000000000..e5beb3cdf Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/find-replace.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/formatting-toolbar.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/formatting-toolbar.png new file mode 100644 index 000000000..aeceb8363 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/formatting-toolbar.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-image.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-image.png new file mode 100644 index 000000000..30190b7e2 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-image.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-link.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-link.png new file mode 100644 index 000000000..aef7ff4f9 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-link.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-table.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-table.png new file mode 100644 index 000000000..da40e70b8 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/insert-table.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/mentions.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/mentions.png new file mode 100644 index 000000000..8130c8c61 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/mentions.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/note-formatting.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/note-formatting.png new file mode 100644 index 000000000..b2aaa8480 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/note-formatting.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/slash-menu.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/slash-menu.png new file mode 100644 index 000000000..a70de11a4 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/slash-menu.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/table-of-contents.png b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/table-of-contents.png new file mode 100644 index 000000000..23e7b08b9 Binary files /dev/null and b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/img/text-editor/table-of-contents.png differ diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/index.md b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/index.md index 13a3de5d5..634a3a777 100644 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/index.md +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/index.md @@ -22,8 +22,8 @@ Dieser Abschnitt behandelt typische Aufgaben wie Inhalte erstellen und verschieb - [Elemente löschen und aus dem Papierkorb wiederherstellen](./delete-restore.md) Entfernen Sie Dateien und Ordner und stellen Sie sie bei Bedarf später wieder her. -- [Markdown-Dateien bearbeiten](./markdown-editor.md) - Bearbeiten Sie `README.md` und andere Markdown-Dateien direkt in OpenCloud mit Formatierungshilfen. +- [Texteditor](./text-editor.md) + Erstellen und bearbeiten Sie Markdown-Dateien, OpenCloud-Notizen und unformatierte Textdateien direkt im Browser. Formatieren Sie Inhalte und arbeiten Sie in Echtzeit gemeinsam an Dokumenten. - [README-Dateien in Ordnern](./readme-files.md) Fügen Sie einem Ordner eine `README.md`-Datei hinzu, damit OpenCloud sie oberhalb der Dateiliste rendert. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/markdown-editor.md b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/markdown-editor.md deleted file mode 100644 index 206c7d105..000000000 --- a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/markdown-editor.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: markdown-editor -sidebar_position: 40 -title: Markdown-Dateien bearbeiten -description: Erfahren Sie, wie Sie Markdown-Dateien mit dem OpenCloud Tiptap-Editor bearbeiten. ---- - -# Markdown-Dateien bearbeiten - -OpenCloud verwendet einen Tiptap-basierten Markdown-Editor für Dateien wie `README.md` und andere `.md`-Dateien. Der Editor hilft Ihnen dabei, Inhalte zu schreiben und zu formatieren, auch wenn Sie die Markdown-Syntax nicht gut kennen. - -## So funktioniert der Editor - -Wenn Sie eine Markdown-Datei öffnen, zeigt OpenCloud sie im Editor an, sodass Sie die Datei direkt im Browser bearbeiten können. - -Markdown-Editor mit einer README-Datei geöffnet - -Sie können Überschriften, Listen, Links, Zitate, Code und andere häufige Formatierungen hinzufügen, ohne die Dateiansicht zu verlassen. - -Während Sie bearbeiten, zeigt OpenCloud den Markdown-Inhalt direkt gerendert an, sodass Sie sofort sehen können, wie die Datei aussehen wird. - -Der Editor unterstützt außerdem das Einfügen von Bildern und das Erstellen von Tabellen, sodass Sie reichhaltigere Markdown-Dateien direkt in OpenCloud einfacher erstellen können. - -## Slash-Kürzel verwenden - -Geben Sie `/` in einer neuen Zeile ein, um das Formatierungsmenü zu öffnen. - -Das Menü gibt Ihnen einen schnellen Überblick über die verfügbaren Formatierungsoptionen und erlaubt es Ihnen, diese zu nutzen, ohne sich jede Tastenkombination merken zu müssen. - -Slash-Menü im Markdown-Editor - -Das ist besonders hilfreich, wenn Sie schnell formatieren möchten und dabei die Hände auf der Tastatur lassen wollen. - -## Formatierungsleiste verwenden - -Verwenden Sie die Formatierungsleiste oberhalb des Editors, um häufige Markdown-Elemente einzufügen. - -Klicken Sie auf die Schaltfläche `Heading`, um eine Überschriftenebene auszuwählen, oder verwenden Sie die anderen Schaltflächen für Fett, Kursiv, Listen, Code, Bilder und Tabellen. - -Das ist besonders hilfreich, wenn Sie Inhalte schnell formatieren möchten, ohne sich jede Markdown-Tastenkombination merken zu müssen. - -## Unterstützte Formatierung - -Der Markdown-Editor unterstützt gängige Formatierungsoptionen für alle Markdown-Dateien. Sie können die Formatierungsleiste oder das Slash-Menü verwenden, um Folgendes einzufügen: - -- Überschriften -- Fett und kursiven Text -- Aufzählungs- und nummerierte Listen -- Zitate -- Inline-Code und Codeblöcke -- Links -- Bilder -- Tabellen - -## Gut zu wissen - -- Der Editor funktioniert für Markdown-Dateien wie `README.md`. -- Sie können das Formatierungsmenü verwenden, um strukturierte Inhalte Schritt für Schritt zu erstellen. -- Die Datei bleibt eine normale Markdown-Datei und kann daher auch außerhalb von OpenCloud verwendet werden. - -Wenn die Datei gespeichert wird, wird der Markdown-Inhalt in derselben `.md`-Datei gespeichert und kann überall dort gerendert werden, wo Markdown unterstützt wird. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/text-editor.md b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/text-editor.md new file mode 100644 index 000000000..6e4dc4db8 --- /dev/null +++ b/i18n/de/docusaurus-plugin-content-docs/current/user/files-and-folders/text-editor.md @@ -0,0 +1,172 @@ +--- +id: text-editor +sidebar_position: 40 +title: Texteditor +description: Textdokumente und Notizen in OpenCloud erstellen, formatieren, gemeinsam bearbeiten und speichern. +--- + +# Den Texteditor verwenden + +Ab OpenCloud 8.0 können Sie mit dem integrierten, auf Tiptap basierenden Texteditor verschiedene Textdateien direkt im Browser bearbeiten. Erstellen und formatieren Sie Markdown-Dokumente und OpenCloud-Notizen, ohne zusätzliche Software zu installieren. Wenn die gemeinsame Bearbeitung aktiviert ist, können mehrere Personen gleichzeitig an einem Dokument arbeiten. + +## Dokument erstellen oder öffnen + +So erstellen Sie ein Dokument: + +1. Öffnen Sie den Ordner oder Space, in dem Sie das Dokument speichern möchten. +2. Wählen Sie `Neu`. +3. Wählen Sie `Notiz` für eine `.ocnote`-Datei oder `Markdown-Datei` für eine `.md`-Datei. +4. Geben Sie einen Dateinamen ein und bestätigen Sie die Erstellung. + +Das neue Dokument wird automatisch im Texteditor geöffnet. + +Um ein vorhandenes Dokument zu öffnen, wählen Sie es in der Dateiliste aus. Falls es nicht standardmäßig im Texteditor geöffnet wird, öffnen Sie das Kontextmenü der Datei und wählen Sie `Öffnen mit ...` und anschließend `Texteditor`. + +Texteditor mit einem formatierten Markdown-Dokument + +:::note + +Zum Bearbeiten einer Datei benötigen Sie die entsprechende Berechtigung. Mit Leseberechtigung können Sie das Dokument ansehen und bei gemeinsamer Bearbeitung die Änderungen anderer mitverfolgen, aber selbst keine Änderungen vornehmen. + +::: + +## Dateiformat auswählen + +Welches Format sich am besten eignet, hängt davon ab, wie Sie das Dokument verwenden möchten. + +| Format | Geeignet für | Formatierungsmöglichkeiten | +| --- | --- | --- | +| Markdown (`.md`) | Dokumente, die Sie auch außerhalb von OpenCloud mit anderen Markdown-Editoren bearbeiten möchten | Überschriften, Textauszeichnungen, Listen, Zitate, Links, Bilder, Tabellen und Code | +| OpenCloud-Notiz (`.ocnote`) | Notizen mit zusätzlichen Formatierungsmöglichkeiten, die Sie hauptsächlich in OpenCloud bearbeiten | Markdown-ähnliche Funktionen sowie Schriftgröße, Text- und Hintergrundfarben, Zeilenabstand, Textausrichtung, Unterstreichung, Tief- und Hochstellung | +| Einfacher Text (`.txt`) | Texte ohne Formatierung, beispielsweise Protokolle oder einfache Notizen | Keine Textformatierung; Suchen, Ersetzen und Drucken sind weiterhin möglich | + +OpenCloud-Notizen werden als `.ocnote`-Dateien im JSON-Format gespeichert. Sie sind keine Markdown-Dateien und bieten zusätzliche Formatierungsmöglichkeiten. + +OpenCloud-Notiz mit erweiterten Formatierungsoptionen und geöffnetem Menü für die Textfarbe + +## Inhalte formatieren + +Über die Formatierungsleiste können Sie Änderungen rückgängig machen oder wiederherstellen, Text formatieren, Listen erstellen und weitere Inhalte einfügen. Wenn nicht alle Schaltflächen in das Fenster passen, finden Sie die übrigen Funktionen unter `Weitere Aktionen`. + +Formatierungsleiste des OpenCloud-Texteditors + +So formatieren Sie Text: + +1. Markieren Sie den gewünschten Text oder setzen Sie den Cursor in den Absatz, den Sie ändern möchten. +2. Über `Umwandeln in` können Sie beispielsweise einen Absatz, eine Überschrift, ein Zitat oder einen Codeblock auswählen. +3. Verwenden Sie die Formatierungsleiste, um Text beispielsweise fett, kursiv oder durchgestrichen darzustellen oder eine Liste zu erstellen. + +### Slash-Menü verwenden + +Geben Sie am Anfang einer Zeile `/` ein, um das Slash-Menü zu öffnen. Sie können anschließend nach einer Funktion suchen oder direkt einen Eintrag auswählen, beispielsweise eine Überschrift, eine Liste, ein Zitat, einen Codeblock, einen Link, ein Bild oder eine Tabelle. + +Slash-Menü mit Funktionen zum Formatieren und Einfügen von Inhalten + +Wenn Sie den Mauszeiger neben einen Inhaltsblock bewegen, können Sie über `Inhalt hinzufügen` einen weiteren Block einfügen. Mit `Zum Verschieben ziehen` können Sie Blöcke am Computer an eine andere Position verschieben. + +### Link einfügen + +1. Markieren Sie den Text, den Sie verlinken möchten, oder setzen Sie den Cursor an die gewünschte Stelle. +2. Wählen Sie `Link` in der Formatierungsleiste oder im Slash-Menü. +3. Geben Sie die Zieladresse und den Linktext ein. + +Dialog zum Einfügen eines Links mit Feldern für die Adresse und den Linktext + +### Code einfügen + +Verwenden Sie `Inline-Code`, um einzelne Codeelemente innerhalb eines Satzes darzustellen. Für längere Codeabschnitte wählen Sie `Codeblock` über `Umwandeln in` oder das Slash-Menü. Der Editor bietet Syntaxhervorhebung für unterstützte Programmiersprachen. Er erkennt die Sprache nach Möglichkeit automatisch; Sie können sie auch selbst auswählen. + +Codeblock mit Syntaxhervorhebung und Auswahl der Programmiersprache + +## Bilder und Tabellen einfügen + +### Bild einfügen + +1. Setzen Sie den Cursor an die Stelle, an der Sie das Bild einfügen möchten. +2. Wählen Sie `Bild einfügen` in der Formatierungsleiste oder geben Sie `/image` ein. +3. Wählen Sie eine der verfügbaren Optionen: + - `Bild aus Datei`: Laden Sie ein Bild von Ihrem Gerät hoch. + - `Bild von URL`: Fügen Sie ein Bild über eine `http://`- oder `https://`-Adresse ein. + - `Aus Cloud einfügen`: Wählen Sie ein Bild aus, das bereits in OpenCloud gespeichert ist. Diese Option steht beim Zugriff über einen öffentlichen Link nicht zur Verfügung. +4. Klicken Sie auf das eingefügte Bild, um seine Größe mithilfe der Ziehpunkte anzupassen. + +Menü mit den verfügbaren Optionen zum Einfügen eines Bildes + +### Tabelle einfügen + +1. Setzen Sie den Cursor an die Stelle, an der Sie die Tabelle einfügen möchten. +2. Wählen Sie `Tabelle erstellen` in der Formatierungsleiste oder im Slash-Menü. +3. Legen Sie die Anzahl der Zeilen und Spalten fest. +4. Klicken Sie in eine Tabellenzelle, um die Bearbeitungsfunktionen aufzurufen. + +Mit den Tabellenfunktionen können Sie Zeilen und Spalten hinzufügen oder entfernen, die Kopfzeile aktivieren oder deaktivieren und die Tabelle löschen. + +Tabelle in einem Dokument + +## Text suchen und im Dokument navigieren + +### Text suchen und ersetzen + +Öffnen Sie `Suchen und Ersetzen` über die Formatierungsleiste oder mit `Strg + F` (`Cmd + F` unter macOS). Geben Sie den Suchbegriff und bei Bedarf den Text ein, durch den Sie ihn ersetzen möchten. Sie können die Suche auf ganze Wörter beschränken oder die Groß- und Kleinschreibung berücksichtigen. + +Such- und Ersetzen-Funktion im OpenCloud-Texteditor + +### Über das Inhaltsverzeichnis navigieren + +Für Markdown-Dateien und OpenCloud-Notizen erstellt der Editor automatisch ein Inhaltsverzeichnis aus den Überschriften des Dokuments. Öffnen Sie dazu den Bereich `Gliederung`. + +Klicken Sie auf eine Überschrift, um direkt zur entsprechenden Stelle zu springen. Beim Scrollen wird die aktuelle Position im Inhaltsverzeichnis hervorgehoben. Wenn Sie Überschriften ändern, wird das Inhaltsverzeichnis automatisch aktualisiert. + +Markdown-Dokument mit geöffnetem Bereich Gliederung + +## Dokumente gemeinsam bearbeiten + +Markdown-Dateien und OpenCloud-Notizen können von mehreren Personen gleichzeitig bearbeitet werden. Änderungen werden in Echtzeit zwischen den geöffneten Editoren synchronisiert. In der Formatierungsleiste sehen Sie, wer das Dokument gerade geöffnet hat. Farbige Cursor zeigen an, an welcher Stelle andere Personen arbeiten. + +Personen mit Bearbeitungsberechtigung können Änderungen vornehmen. Mit Leseberechtigung können Sie die gemeinsame Bearbeitung mitverfolgen, ohne selbst Inhalte zu ändern. + +Gemeinsame Bearbeitung eines Markdown-Dokuments mit zwei aktiven Personen + +### Andere Personen erwähnen + +Geben Sie in einem Markdown-Dokument oder einer OpenCloud-Notiz `@` ein und wählen Sie eine Person aus der Vorschlagsliste. Angezeigt werden nur Personen, die bereits Zugriff auf das Dokument haben. + +Die Benachrichtigung über die Erwähnung wird nach dem Speichern des Dokuments versendet. Ob die erwähnte Person eine Benachrichtigung erhält, hängt von den Benachrichtigungseinstellungen ab. + +Über öffentliche Links können Sie keine Personen erwähnen. + +Vorschlagsliste für die Erwähnung einer Person im Texteditor + +:::note + +Für die gemeinsame Bearbeitung in Echtzeit muss der Yjs-Dienst eingerichtet sein. Informationen zur Einrichtung finden Administratoren unter [Gemeinsames Bearbeiten mit dem Yjs-Server](../../admin/configuration/collaborative-editing). + +::: + +Bei der gemeinsamen Bearbeitung gelten folgende Einschränkungen: + +- Über öffentliche Links ist keine gemeinsame Bearbeitung in Echtzeit möglich. Personen mit Schreibberechtigung können das Dokument weiterhin bearbeiten und speichern. Ihre Änderungen werden jedoch nicht unmittelbar in anderen geöffneten Editoren angezeigt. +- In Ende-zu-Ende-verschlüsselten Ordnern ist die gemeinsame Bearbeitung deaktiviert. +- Während der gemeinsamen Bearbeitung ist der Quelltextmodus schreibgeschützt, da sich direkte Änderungen am Quelltext nicht mit der gemeinsamen Bearbeitung zusammenführen lassen. + +## Änderungen speichern + +Bei der gemeinsamen Bearbeitung ist zwischen der Synchronisierung der Änderungen und dem Speichern der Datei zu unterscheiden: + +- Änderungen werden sofort zwischen den Personen synchronisiert, die gemeinsam am Dokument arbeiten. +- Die Datei wird gespeichert, wenn jemand `Speichern` auswählt, `Strg + S` (`Cmd + S` unter macOS) drückt oder die automatische Speicherung erfolgt. +- Das Intervall für die automatische Speicherung legt der Administrator fest. Wenn die automatische Speicherung aktiviert ist, wird das Intervall im Editor angezeigt. + +Wenn eine andere Anwendung, beispielsweise der Desktop Client, die geöffnete Datei verändert, erhalten Sie im Editor einen Hinweis. Liegen keine ungespeicherten Änderungen vor, lädt der Editor automatisch die neuere Version. + +Haben Sie noch ungespeicherte Änderungen, können Sie diese mit `Speichern unter` in einer separaten Datei sichern. Alternativ können Sie die Seite neu laden. Dabei werden Ihre ungespeicherten Änderungen verworfen und die extern geänderte Version geöffnet. + +Bei jedem Speichern wird die Datei in OpenCloud aktualisiert. Frühere Dateistände stehen entsprechend den Regeln der [Dateiversionierung](./versions.md) zur Verfügung. + +## Gut zu wissen + +- Markdown-Dateien können auch mit anderen Markdown-Editoren bearbeitet werden. Die Darstellung kann sich je nach Anwendung leicht unterscheiden. +- OpenCloud-Notizen (`.ocnote`) unterstützen Formatierungen, die Markdown nicht abbilden kann. Sie sind für die Bearbeitung im OpenCloud-Texteditor vorgesehen. +- Codeblöcke bieten Syntaxhervorhebung für gängige Programmier- und Konfigurationssprachen. +- Über `Drucken` öffnen Sie den Druckdialog des Systems. Je nach Betriebssystem können Sie das Dokument dort auch als PDF speichern. Die PDF-Datei wird lokal gespeichert und nicht automatisch in OpenCloud abgelegt. +- Wie Sie eine `README.md` oberhalb der Dateiliste eines Ordners anzeigen, erfahren Sie unter [README-Dateien in Ordnern](./readme-files.md). \ No newline at end of file diff --git a/redirects.ts b/redirects.ts index d6224d82e..fefb50038 100644 --- a/redirects.ts +++ b/redirects.ts @@ -3,5 +3,9 @@ export const redirects = [ to: '/docs/admin/getting-started/container/docker-compose/docker-compose-base', from: ['/docs/admin/getting-started/container/docker-compose-local'], }, + { + to: '/docs/next/user/files-and-folders/text-editor', + from: ['/docs/next/user/files-and-folders/markdown-editor'], + }, // Add more redirects here as needed ];