-
Notifications
You must be signed in to change notification settings - Fork 5
99 Template
Example text
Align text to the right
1. Heading 1 (Chapter) |
Page contents |
Note
Highlights information that users should take into account, even when skimming.
1 STL or statement list is a text-based programming language similar to assembler language
Indented second line
2 Ladder logic is a graphical programming language widely used to programme Controllers and PLCs
Tip
Optional information to help a user be more successful.
Important
Crucial information necessary for users to succeed.
Warning
Critical content demanding immediate user attention due to potential risks.
Caution
Negative potential consequences of an action.
This template page is simply a location where examples for Wiki pages are stored and some note on how to structure and organise the Wiki page. I will at some point make the notes clearer and more informative. At the moment, it's just somewhere to store examples of what I've learned so far.
All headings have the format of:
#..# Text
The number of hashes represents the level of heading, there must be a space following the last # before starting the heading text itself.
To make the headings (which are different sizes for different levels) line up (it looks like this):
The number is followed by a combination of em spaces, en spaces and non-breaking spaces.
When linking to the headings in a table of contents, all spaces are replaced wiht a dash (-) and all non-alphanumeric characters are ignored. The link starts with a single hash (irrespective of the heading level), thus a link to heading: 1.1.1 Heading 1.1.1 (subsection) would be:
    [1.1.1  Heading 1.1.1 (Subsection)](#111heading-111-subsection)<br>
It looks like this
1.1.1 Heading 1.1.1 (Subsection)
Each line should be ended with <br>
Use <br>
to pad out each column to make the columns the same height.
The full table of contents for this page is held in a table at the top of this page
These are the actual headings with the correct formatting (note the use of emojis in the link to the top):
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam quis faucibus leo. Curabitur sem turpis, blandit id pharetra vitae, commodo at felis. Mauris ut pellentesque urna. Pellentesque vehicula ante eget elementum lobortis. Suspendisse id eros massa. Ut quis justo blandit, luctus leo non, euismod eros. Suspendisse a gravida felis. Proin.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam quis faucibus leo. Curabitur sem turpis, blandit id pharetra vitae, commodo at felis. Mauris ut pellentesque urna. Pellentesque vehicula ante eget elementum lobortis. Suspendisse id eros massa. Ut quis justo blandit, luctus leo non, euismod eros. Suspendisse a gravida felis. Proin.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam quis faucibus leo. Curabitur sem turpis, blandit id pharetra vitae, commodo at felis. Mauris ut pellentesque urna. Pellentesque vehicula ante eget elementum lobortis. Suspendisse id eros massa. Ut quis justo blandit, luctus leo non, euismod eros. Suspendisse a gravida felis. Proin.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam quis faucibus leo. Curabitur sem turpis, blandit id pharetra vitae, commodo at felis. Mauris ut pellentesque urna. Pellentesque vehicula ante eget elementum lobortis. Suspendisse id eros massa. Ut quis justo blandit, luctus leo non, euismod eros. Suspendisse a gravida felis. Proin.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam quis faucibus leo. Curabitur sem turpis, blandit id pharetra vitae, commodo at felis. Mauris ut pellentesque urna. Pellentesque vehicula ante eget elementum lobortis. Suspendisse id eros massa. Ut quis justo blandit, luctus leo non, euismod eros. Suspendisse a gravida felis. Proin.
These Wiki pages are essentially a repository within a repository and every change I make is another commit to that repostiory. This is ok I suppose (or it will be when the pages are more complete), but at the moment, I'm still finding out how to use these Wiki pages and make them look good and I'm making a lot of changes just experimenting with things. At this stage I find the endless commits very frustrating.
To get around this, I sometimes purge all the commits that have been made (appart from the first one) and reload the current state of the pages back in to essentially reset the repository and remove all the many commits that have been made in the meantime.
To do this, I synchronise my local repostiory wiht the GitHub wiki to get everything up to date.
Next I backup the local repository to another location (outside of the actual repositiory), the backup includes the .git folder.
I now reset the project to the first commit, my first commit has the hash: ea4da41.
To reset the project, open the git console (terminal -> new), this opens the terminal at the bottom right in VS Code.
Enter the command
git reset --hard ea4da41
This restores the Wiki repository to the empty arrangement I had at the start
I now copy all the files and folders from the backup I made earlier DO NOT COPY THE .GIT FOLDER BACK IN
This puts the files back as they were at the start of all this (i.e. the repository has all the files that were in it at the end of the commit chain).
Now stage all the changes and commit the changes to the local repository, this now has just two commit points, the orignal (empty) repository and the new commit with all the files back in.
The next thing is to forcibly push this change back to GItHub using the following command:
git push origin HEAD --force
Thats it, all the commits are now removed.
██
█ █ Hair space 1px
█ █ Thin space 2px
█ █ Punc space 3px
█ █ Space 4px
█ █ Space
█ █ En space 8px
█ █ Em space 16px
████████
█ █ Space
█0█
█1█
█2█
█3█
█4█
█5█
█6█
█7█
█8█
█9█
█.█
█1.█
⬆️ ➡️ ⬅️ ⬇️
Full list here:
https://gist.github.com/rxaviers/7360908
A collapsed section
You can add text within a collapsed section.
You can add an image or a code block, too.
puts "Hello World"
Click the button below to download the PracticalSeries PAL Software library:
Markdown | HTML | GitHub Output |
---|---|---|
# Heading level 1 |
<h1>Heading level 1</h1> |
|
## Heading level 2 |
<h2>Heading level 2</h2> |
|
### Heading level 3 |
<h3>Heading level 3</h3> |
|
#### Heading level 4 |
<h4>Heading level 4</h4> |
|
##### Heading level 5 |
<h5>Heading level 5</h5> |
|
###### Heading level 6 |
<h6>Heading level 6</h6> |
1. Introducing the PAL
1.1. The approach taken
1.1.1 The structure of the software
1.1.2 The standard modules
1.1.3 The user interface
1.1.4 Templates and documentation
Template modules
Documentation modules
flowchart LR
A(<br>Markdown text<br>in a **.md** file<br><br>) --> B((Markdown processor))
B --> C{<br>HTML<br><br>}
C --> D[<br>Rendered output<br>in a browser<br><br>]
classDiagram
System-Functions : ● Generates common global system signals and timing pulses
System-Functions : ● Reads Controller cycle and real time clock information
System-Functions : ● Reads and identifies any module and system faults
System-Functions-->Read-Instruments
Read-Instruments : ● Reads all analogue and digital instruments
Read-Instruments : ● Scale analog instrument in engineering units
Read-Instruments : ● Digital instruments signals are filtered and stored
Read-Instruments : ● Generate instrument alarms and warnings
Read-Instruments-->Interlocks-and-Protection
Interlocks-and-Protection : Interlocks are overriding conditions that prevent
Interlocks-and-Protection : something from happening when a particular condition
Interlocks-and-Protection : is present
Interlocks-and-Protection-->Safety-Systems
Safety-Systems : Safety systems are used for both machine and personnel
Safety-Systems : protection emergency stop systems for example
Safety-Systems-->Calculations
Calculations : Perform any discreate calculations required by the process,
Calculations : this may be mathematical calculations, timing calculations
Calculations : or even logical calculations
Calculations--> Continuous-Control-Logic
Continuous-Control-Logic : Continuous control is the constant monitoring and evaluation
Continuous-Control-Logic : of plant devices and process variables. The continuous control
Continuous-Control-Logic : logic assesses the condition of the plant and generates actions
Continuous-Control-Logic : to produce the required process conditions.
Continuous-Control-Logic-->Sequential-Control-Logic
Sequential-Control-Logic : Sequential logic operates in a series of successive steps,
Sequential-Control-Logic : each step carrying out an action and waiting for transition
Sequential-Control-Logic : conditions to be satisfied before moving to another step.
Sequential-Control-Logic : Sequential logic is often triggered by the continuous logic
Sequential-Control-Logic-->Command-Execution
Command-Execution : Both continuous and sequential control logic generate actions,
Command-Execution : these actions require something to happen, e.g. a valve to open,
Command-Execution : a drive to start etc.
Command-Execution : The command execution blocks martial these signals and trigger
Command-Execution : the appropriate response (issues the command).
Command-Execution-->Device-Drivers
Device-Drivers : ● Control loop device drivers operate and monitor the PID loops
Device-Drivers : ● Valve drivers operate and monitor all forms of valves
Device-Drivers : ● Motor drivers operate and monitor all forms of motors and drives
Device-Drivers-->Messages
Messages : Handles Controller messages e.g. alarms, warnings, events and
Messages : prompts that require some form of user interaction
Messages-->Communications
Communications : Executes any system-to-system communications e.g. Controller
Communications : to Controller and any other form of communication
Communications : required by the system e.g. point-to-point serial communications,
Communications : ProfiBus field messaging etc.
graph TD;
A[**1 System Functions**
-Generates common signals and timing pulses
Reads cycle and real time clock data
Identifies any system faults
]-->B;
B[**2 Read Instruments** Generates common global system signals and timing pulses]-->c;
- What Is Hystrix?
- What Is Hystrix For?
- What Problem Does Hystrix Solve?
- What Design Principles Underlie Hystrix?
- How Does Hystrix Accomplish Its Goals?
THEME DEPENDANT IMAGE
END OF PICTURE
Published by: The PracticalSeries of Publications Published in the United Kingdom https://practicalseries.com |
Copyright © 2021 Michael Gledhill [email protected] |
Check Box details
Checkbox ticked | |
Checkbox unticked |
Square checkbox (open)
Circular checkbox (open)
Square checkbox (open)
Circular ticked (closed)
This sentence uses $
delimiters to show math inline:
Here is a simple flow chart:
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
graph TD;
A[Test]-->B(Reads all **analogue** and digital instruments.);
B-->c;
<html>
<body>
<!--StartFragment-->
--
<div class="rg-row sub-title-row"> <!-- Start of subtitle row (section number & heading) -->
| <div class="rg-col rg-span1-5"></div> <!-- Left column (not used for subtitle) -->
| <div class="rg-col rg-span3-5"> <!-- Start of subtitle column (centre column) -->
| <!-- <div class="sub-title-overline"></div> OVERLINE IF NEEDED -->
| <div class="sub-title-num-box"><h3>3.2.1</h3></div>
| <div class="sub-title-text-box"><h3>A default text editor for Git</h3></div>
| </div> <!-- End of subtitle column (centre column) -->
| <div class="rg-col rg-span1-5"></div> <!-- Right column (not used for subtitle) -->
| </div> <!-- End of Subtitle row -->
|
<!--EndFragment-->
</body>
</html>
Thanks for visiting The Markdown Guide!
This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.
These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.
bold text
italicized text
blockquote
- First item
- Second item
- Third item
- First item
- Second item
- Third item
code
These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
Syntax | Description |
---|---|
Header | Title |
Paragraph | Text |
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
Here's a sentence with a footnote. [^1]
[^1]: This is the footnote.
term : definition
The world is flat.
- Write the press release
- Update the website
- Contact the media
That is so funny! 😂
(See also Copying and Pasting Emoji)
I need to highlight these ==very important words==.
H2O
X^2^
a b c d e f g h i j k l m n o p q r s t u v w x y z a b c d e f g h i j k l m n o p q r s t u v w x y z a b c d e f g h i j k l m n o p q r s t u v w x y z a b c d e f g h i j k l m n o p q r s t u v w x y z a b c d e f g h i j k l m n o p q r s t u v w x y z a b c d e f g h i j k l m n o p q r s t u v w x y z a b c d e f g h i j k l m n o p q r s t u v w x y z
In principle, liquid rocket engines are simple, far simpler than the internal combustion engine. Liquid fuel is pumped into a combustion chamber in the presence of liquid oxygen and a flame. It burns. That’s all there is to it. There are no crankshafts to turn, no pistons to drive. The burning fuel produces energy in the form of gases that exit through the rocket’s nozzle. The force the gases produce against the top of the engine is called thrust. The thrust is transmitted through the rocket’s structure and, if it is greater than the weight of the rocket, the rocket lifts off. Put in its most basic terms, for any rocket to work there are two things that must be done extremely well: The propellants must be brought together, and then they must burn smoothly. In the F-l, just pumping the propellants to the combustion chamber raised unprecedented demands. The F-l used liquid oxygen (LOX) and R.P.-1, a form of kerosene. The pumps, one for the fuel and one for the LOX, had to deliver the kerosene from the tankage to the combustion chamber at the rate of 15,741 gallons per minute, and the LOX at the rate of 24,811 gallons per minute. Driven by a 55,000-horsepower turbine, the pumps had to operate at drastically different temperatures: 60 degrees Fahrenheit for the fuel, –300 degrees for the LOX, while the turbine itself ran at 1,200 degrees. To complicate matters, the whole assembly had to be light and compact enough to fit on board the rocket and nonetheless sturdy enough to resist the pressures, vibrations, and other stresses of launch and flight. Developing the pumps was still not as hard as solving the second basic problem of rocket engines: making the propellants burn smoothly once they had reached the combustion chamber. The pumps brought the kerosene and the LOX to a circular metal slab three feet in diameter and about four inches thick, weighing 1,000 pounds, called the injector plate. The injector plate was pocked with 6,300 holes less than a quarter of an inch in diameter through which the kerosene and LOX entered the combustion chamber. Most of the propellant streams were arranged in groups of five. Two of the five, both kerosene, impinged on each other at a carefully defined distance below the top of the plate, forming a fan-shaped spray. The other three in each five-hole group were of LOX. These also impinged on one another, forming another fan. The two fans intersected. There, given the presence of a flame, they would combust. In the F-l, the combustion chamber was a barrel about thirty-six inches wide and thirty inches long, closed at one end by the injection plate and opening into a nozzle at the other end. A few seconds before ignition, four small pre-burners in the combustion chamber — pilot lights, in effect — were lit, providing a flame at the point of impingement. As the pumps screamed up to speed, valves snapped open and more than a ton of kerosene and two tons of liquid oxygen burst into the combustion chamber. Per second. The gases produced by their ignition roared out through the throat, the open bottom of the barrel, into the cone of the nozzle below. In the course of the few seconds from ignition to full power (mainstage), the interior of the combustion chamber went from ambient temperature to 5,000 degrees Fahrenheit. At the face of the injector plate, pressure went from zero to 1,150 pounds per square inch. Given that combination of propellants, pressures, and nozzle design, the force generated totalled 1.5 million pounds. In the first stage of a Saturn V, five F-l s were to ignite simultaneously and sustain mainstage combustion for 150 seconds.
abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz
The PracticalSeries of Publications — Copyright © 2021 Michael Gledhill
⬆️ Top | [email protected] | PracticalSeries of Publications | PAL website
██ BODY
█ █
█ █ 30xNum
█ █ 10xEn
█ █ 30xEm/3
█ █ 30xNb/space
█ █ 30xEm/4
█ █ 30xPunc
█ █ 30xThin
█ █ 30xHair
The licences and other details
The Licence
Why did I choose the MIT Licence?
Permissive licences
Copyleft licence
Limiting liabilities
Which licence to use?
A note on spelling
1. Introducing the PAL
1.1. The approach taken
1.1.1 The structure of the software
1.1.2 The standard modules
1.1.3 The user interface
1.1.4 Templates and documentation
Template modules
Documentation modules
1.2. Background to the Project
1.3. Regulations and standards
1.4. Assumptions and limitations
2. The controller software and structure
2.1. Internal structure of the Controllers
2.1.1 Programmable blocks
Organisation blocks (OBs)
Functions (FCs)
Function blocks (FBs)
2.1.2 Data storage blocks
Data blocks (DBs)
Instance data blocks (iDBs)
User data types (UDTs)
2.1.3 Built-in system blocks
2.1.4 Block numbering and quantities
2.2. Execution of Controller software
2.2.1 Cyclic programme execution
90. How to build a GitHub Wiki
90.1. What are GitHub Wiki pages?
90.2. Understanding the Wiki pages
90.3. Creating a Wiki for a repository
90.4. Cloning a Wiki to a local machine
90.5. Basic components of a Wiki
90.5.1 Title bar and revision
90.5.2 Contents area
90.5.3 Listing pages in the order you want
90.6. Sidebars and footers
90.6.1 What are sidebars and footers?
90.6.2 Create a sidebar or footer in GitHub
90.6.3 Create a sidebar or footer locally
91. Imposing a folder structure on a Wiki
91.1. The default arrangement
91.2. A practical Wiki folder structure
91.2.1 Page Numbering in the Wiki
91.2.2 Rules for page numbering
91.2.2 Subfolder names for Wiki pages
91.2.3 Page names for Wiki pages
91.2.4 Storing images and other data
92. Markdown, GitHub Markdown and HTML
A note by the Author
Some useful Markdown sites
92.1. An overview of Markdown
92.2. How Markdown works
92.3. Markdown flavours
92.3.1 GitHub Flavoured Markdown (GFM)
92.4. HTML and Markdown
92.4.1 HTML with GitHub Markdown
GFM Blacklisted HTML tags
GFM Whitelisted HTML tags
GFM HTML tags — the grey area
GFM whitelisted HTML attributes
92.5. PracticalSeries Markdown
⬇️ End of page |