Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

Commit

Permalink
ci: disable commitlint
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanprobst committed Mar 19, 2024
1 parent ac682bc commit e1a73d7
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions content/documentation/en/howto.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ Researchers and members of the ACDH-CH can profit from the platform and easily s

Then you have found the right place! With our HowTo-Platform and the following step-by-step guide you will be able to easily share your knowledge with others.

<SideNote type="info">
<Callout kind="note" title="Info">
The following section shows the creation of content based on an idea. If a draft, an edited text or practice materials have already been created, you can skip directly to the section “How can I publish an article?”.
</SideNote>
</Callout>

## How do I design an article

Expand Down Expand Up @@ -84,43 +84,43 @@ To publish a text, you only need a [GitHub account](https://github.com/) that is

The first important step is to create an author profile for yourself. On the left-hand side under “Contents” select “People”. By clicking the button “New Person” you can now create your author profile. Save the entries and publish them.

<Figure src="images/e8818bec-089c-4ef4-a474-ff6692e6f0c1.png">
<Figure src="/assets/content/documentation/e8818bec-089c-4ef4-a474-ff6692e6f0c1.png">
Screenshot: Adding a new author
</Figure>

### Step 2: Creating a new post

You can either create a new post under “Collections” and “Posts” with the button “New Post” or do this with the second tab entitled “Workflow”. In the workflow you can find all the articles that are currently being edited or that are awaiting approval and publication. Should you have to interrupt your work, you can come back to the tab “Workflow”, and find all the articles that are currently being edited in the column “Drafts” and continue working from there. As soon as you make any changes to your post, the platform will automatically remind you to save or discard them before exiting the page.

<Figure src="images/6ae3fa2a-e4c5-4166-9b80-70c0ee7155a2.png">
<Figure src="/assets/content/documentation/6ae3fa2a-e4c5-4166-9b80-70c0ee7155a2.png">
Screenshot: Creating a new post
</Figure>

<SideNote type="info">
<Callout kind="note" title="Info">
Posts are always saved as drafts first. Once you have finished working on your text, you can change the draft to “In Review”, and the editorial team will then have a look at your material. Once this has been done, the article will be set to “Ready” and subsequently published. Only after the publication, it is visible on the front end of the Learning Resources Platform.
</SideNote>
</Callout>

When creating a new post (or opening a preexisting one by clicking on it), the screen will split into two halves. On your left is the editing area and on your right you can immediately see what your article will look like on the HowTo-Platform in the preview-mode. The preview-mode can be activated and deactivated with the eye symbol at the top right.

Every post starts with a few formal entries. Namely, the title, which should be short and succinct, the language, the date, the author(s), editor(s), tags and a short abstract. Some fields only allow selections from a drop-down menu. Should the desired option not be available, it needs to be created beforehand. A new author can be added by every user (see instructions in step 1), for new tags please contact the editorial team at acdh-ch-training@oeaw.ac.at.

<SideNote type="tip">
<Callout kind="tip" title="Tip">
The first saved entry in the field “Title” will be used for the post's URL. To create a simple and easily legible URL, we therefore recommend entering only a few significant words without using any Umlaut or special characters into the title field for your first save.

In our example (see photo) we used “Test Example Entry” in our title field and saved it. Afterwards, the title can be changed as desired but the URL will always remain “test-example-entry”.

<Figure src="images/aa2380be-ed1f-41da-9040-0800e5d86dbd.png">
<Figure src="/assets/content/documentation/aa2380be-ed1f-41da-9040-0800e5d86dbd.png">
Screenshot: Title and URL after first save
</Figure>
</SideNote>
</Callout>

Following the formal entries of title, language and abstract, you will find the text field for the content of your article. It can be entered in rich-text-format or in markdown and you can change between the two at any time using the slider control (highlighted in yellow in the screenshot below). To save a post every required field, including content, must contain an entry.

### Step 3: The most important editing tools for your content

In rich-text there are several different formatting options such as bold, italic, headings, lists, etc. at your disposal (encircled in green in the screenshot). Moreover, you can use the plus symbol (highlighted in blue) to use different preprogrammed features, like inserting pictures, videos, code blocks, tip boxes or quizzes.

<Figure src="images/70cc7f61-323c-49f7-b742-c583b51cbe02.png">
<Figure src="/assets/content/documentation/70cc7f61-323c-49f7-b742-c583b51cbe02.png">
Screenshot: Editing tools in CMS
</Figure>

Expand All @@ -139,7 +139,7 @@ A short explanation will be shown when hovering above each formatting symbol wit
- Image: add images by uploading the file or entering a URL
- Code block: insert a longer code block
- Figure: insert images. Unlike the feature "image", "figure" allows users to add markdown-content in the image caption and consequently add links or quotation marks.
- SideNote: lets you add a note or tip. There are different options available that highlight a text in different colours in the text . The drop-down-menu “type” shows the options available.
- Callout: lets you add a note or tip. There are different options available that highlight a text in different colours in the text . The drop-down-menu “type” shows the options available.
- Video: embed a video from Youtube, Vimeo or Nakala. You can also add the timestamp from which the video should start playing and activate the autoplay function if you like.
- Quiz: This gives you the opportunity to design and insert one or multiple questions. The number of answer possibilities can be determined with “Options”. Each possibility must also be indicated as true or false. “Messages” allows you to add feedback for the learner, so that they know why an answer is true or false. “Control” allows you to name the button that should be clicked by the learner for verification. The system default for that is “Validate”. If preview-mode is activated (eye symbol), you can immediately see what your multiple-choice question looks like on the right-hand side of the browser and test the answer options. Correct answers are shown in green, wrong answers in red. Note that answers always must be clearly right or wrong.
- Tabs: This feature allows you to create a section with tabs within your article. Users can then switch between several options without having to leave the main page. This could be useful, for example, when you want to explain the installation of a tool or programme that requires different input on different operating systems, e.g. Windows and Mac.
Expand Down

0 comments on commit e1a73d7

Please sign in to comment.