User Manual

awaBerry Anywhere Markdown Editor

This page provides a full-screen Markdown editor that allows users to create, edit, preview, and save Markdown content. It supports various viewing modes and includes features for searching text and managing user session notifications.

awaBerry Anywhere Markdown Editor

Summary

The awaBerry Anywhere Markdown Editor is a versatile tool for managing Markdown content. It offers three distinct viewing modes: Editor, Split, and Preview, allowing users to focus on writing, view both code and live output, or solely see the formatted result. The editor automatically saves content periodically if the user is active and can also be manually saved. It also includes integrated session management features that notify users when their session is about to expire or has already expired, prompting necessary actions to maintain access.

Page Access

You can access this page by navigating to: /automization

Page Functionalities

Text Editor

This is the main area where you write your Markdown content. It supports multi-line input.

Save Button

(If available) Allows you to manually save your work. The system also performs automatic saves every 60 seconds when you are active. A spinning indicator shows when saving is in progress.

View Modes

  • Editor: Shows only the text editor, ideal for focused writing.
  • Split: Displays the text editor and a live preview of your Markdown side-by-side. You can drag the divider to adjust the size of each panel.
  • Preview: Shows only the rendered Markdown, giving you a full-screen view of your content.

Search Functionality

Located at the top-right corner of the editor, this feature allows you to find specific text within your Markdown content.

  • Search Bar: Appears at the top of the editor when activated by clicking the search icon.
  • Search Input: Type your search term here. All matches will be highlighted in yellow, with the currently selected match highlighted in orange.
  • Navigation Buttons (Up/Down Arrows): Use these to move between previous and next search results.
  • Close Button (X): Closes the search bar and removes all highlights.

Session Notifications

The system will notify you if your user session is about to expire or has already expired, helping you to stay informed about your login status and prevent potential data loss.

Scenario Executions

Possible usage steps within this page

Editing and Saving Markdown Content

This describes how to modify and save your Markdown documents.

  1. Open Editor: Navigate to the Markdown Editor page.
  2. Edit Text: Type or paste your Markdown content into the main text area.
  3. Save Changes: Click the 'Save' button in the top right corner of the application bar. You will see a small loading indicator while saving, which disappears once the save is complete.

Switching View Modes

This describes how to change how you view your Markdown content.

  1. Editor Mode: Click the 'Editor' button in the application bar to view only the text editing area.
  2. Split Mode: Click the 'Split' button to see both the text editor and a live preview side-by-side. You can drag the grey bar between the two sections to resize them.
  3. Preview Mode: Click the 'Preview' button to view only the rendered Markdown document in full-screen.

Searching for Text

This describes how to find specific text within your Markdown document.

  1. Activate Search: Click the magnifying glass icon at the top-right of the editor area.
  2. Enter Search Term: Type the text you want to find into the search bar that appears.
  3. Navigate Results: Use the 'Up' and 'Down' arrow buttons next to the search bar to jump between highlighted search results.
  4. Close Search: Click the 'X' button in the search bar to close it and remove all highlights.

Possible errors which may occur on this page

Error Saving Project

If you encounter an "Error saving project" message after clicking the save button, this indicates that the system was unable to save your changes. This can happen due to network connectivity issues or problems with the server. Please check your internet connection and try again.

Session Expiration

If your session is about to expire, a notification will appear to warn you. If your session fully expires, the editor page will automatically close, and a persistent notification will inform you that your session has ended, requiring you to log in again to continue working.