Difference between revisions of "Demo Document for EHR"

From LibreHealth EHR Wiki
Jump to: navigation, search
(Creating the Document)
(= Heading 2 (for Introduction, Procedure and Summary) =)
(9 intermediate revisions by the same user not shown)
Line 51: Line 51:
  
 
[[File:Koni-coding-2.png]]
 
[[File:Koni-coding-2.png]]
 +
 +
 +
Choosing the '''Ab''' button creates a link to another section of the document. This is done with two square brackets opening and closing the link name. Then create a span tag with an # id name.
 +
 +
[[File:Koni-coding-3.png]]
 +
 +
 +
For instance, to link from this page to the Summary section, you would code:
 +
 +
<nowiki>[[#summary|Summary]]</nowiki>
 +
 +
If this was coded in HTML, it would look like this:
 +
 +
<nowiki><a href="#summary">Summary</a></nowiki>
 +
 +
Then before the Summary, you would code:
 +
 +
<nowiki><span id="summary"></nowiki>
 +
 +
Choosing the '''Globe''' creates a link outside of the document.
 +
 +
[[File:Koni-coding-4.png]]
 +
 +
 +
Remember to leave a space between the url and the name.
 +
 +
Choosing the '''A''' button will show how to make a Level 2 heading.
 +
 +
[[File:Koni-coding-5.png]]
 +
 +
 +
Heading structures use the equal sign on each side of the text. The number of equal signs reflect the header level. In this example, there is a space between each = to show the difference. However, in the actual document – there should be no spaces.
 +
 +
<nowiki>= Heading 1 (or Document Title) =</nowiki>
 +
 +
<nowiki>= = Heading 2 (for Introduction, Procedure and Summary) = =</nowiki>
 +
 +
<nowiki>= = = Heading 3 (for each main sub-section of Heading 2) = = =</nowiki>
 +
 +
<nowiki>= = = = Heading 4 = = = =</nowiki>
 +
 +
<nowiki>= = = = Heading 5 = = = = =</nowiki>
 +
 +
<nowiki>= = = = = = Heading 6 = = = = = = </nowiki>
 +
 +
There must be the same number of equal signs on each side of the heading.
 +
 +
You will find this Heading Structure shows up automatically in the Contents section of the Document. It will help you to see if the structure is correct, or needs to be fixed.
 +
 +
 +
Choosing the Picture creates a link to an image file.

Revision as of 00:35, 24 May 2020

Working with LibreHealth Wiki Documents

Introduction

LibreHealth EHR is a robust electronic health records system. As such, it requires a strong library of guides to help the user enjoy a positive experience. Our library is the LibreHealth Wiki.

This document will strive to help you understand the different markdown codes and formats that you will encounter when you create your documents in our library.

Toni (KoniKodes) Shortsleeve, LibreHealth / Outreachy EHR Documentation Mentor, May 2020

Procedure

In order to log in, you will need to be granted access from our lead mentor, Harley Tuck.

When you first log in, you will see the Main Page.

Koni-main-page-1.png


Do Not Edit This Page – unless you have been given express permission

Type in the name of the document you want to create into the Search Bar.

Koni-main-page-2.png


If this is a new document, you will see this:

Koni-main-page-3a.png


Don’t panic. Clink on the red link to create a new page.

And now the fun begins…

Creating the Document

Koni-main-page-4a.png


The Coding Bar

The Coding Bar can be very helpful when you first begin using wiki.

Choosing the B button makes the text bold. This is done with 3 ticks on each side of the text.

Koni-coding-1.png


Choosing the I button makes the text italic. This is done with 2 ticks on each side of the text.

Koni-coding-2.png


Choosing the Ab button creates a link to another section of the document. This is done with two square brackets opening and closing the link name. Then create a span tag with an # id name.

Koni-coding-3.png


For instance, to link from this page to the Summary section, you would code:

[[#summary|Summary]]

If this was coded in HTML, it would look like this:

<a href="#summary">Summary</a>

Then before the Summary, you would code:

<span id="summary">

Choosing the Globe creates a link outside of the document.

Koni-coding-4.png


Remember to leave a space between the url and the name.

Choosing the A button will show how to make a Level 2 heading.

Koni-coding-5.png


Heading structures use the equal sign on each side of the text. The number of equal signs reflect the header level. In this example, there is a space between each = to show the difference. However, in the actual document – there should be no spaces.

= Heading 1 (or Document Title) =

= = Heading 2 (for Introduction, Procedure and Summary) = =

= = = Heading 3 (for each main sub-section of Heading 2) = = =

= = = = Heading 4 = = = =

= = = = Heading 5 = = = = =

= = = = = = Heading 6 = = = = = =

There must be the same number of equal signs on each side of the heading.

You will find this Heading Structure shows up automatically in the Contents section of the Document. It will help you to see if the structure is correct, or needs to be fixed.


Choosing the Picture creates a link to an image file.