eicwiki
The mbed wiki syntax is a plain text markup based on the standardised Creole wiki markup, with some enhancements we find useful.
Text and Paragraphs¶
This is a first sentence. And a second. And a third.
This is a first sentence. And a second.
And a third.
forced\\linebreak
forced
linebreak
Text above separator line ---- Text below separator line
Text above separator line
Text below separator line
Headings¶
= Heading 1 = == Heading 2 == === Heading 3 ===
Heading 1¶
Heading 2¶
Heading 3¶
Styles¶
**bold text**, //italic//, __underline__, --stroke--, ^^superscript^^, ,,subscript,,, ##monospace##
bold, italic, underline, stroke, superscript, subscript, monospace
**//bold italic//**, **##bold monospaced##**
bold italic, bold monospaced
Alignment¶
Text floated to the right
<<float side=right>> Text floated to the right <</float>>
Lists¶
* List Item 1 * List Item 2 ** List Item 2.1 * List Item 3
- List Item 1
- List Item 2
- List Item 2.1
- List Item 3
# Ordered Item 1 ## Ordered Item 1.1 ## Ordered Item 1.2 ### Ordered Item 1.2.1 # Ordered Item 2
- Ordered Item 1
- Ordered Item 1.1
- Ordered Item 1.2
- Ordered Item 1.2.1
- Ordered Item 2
Links¶
* [[Wiki Syntax]] * [[/handbook/SPI]] * [[http://mbed.org]] * [[/media/uploads/simon/helloworld_lpc1768.bin]] * [[/handbook/SPI|SPI Handbook Page]]
- Wiki Syntax
- /handbook/SPI
- http://mbed.org
- /media/uploads/simon/helloworld_lpc1768.bin
- SPI Handbook Page
Images¶
{{URL|description|width|height}} {{/media/uploads/simon/mbed.gif}} {{/media/uploads/simon/mbed.gif|mbed Logo}} {{/media/uploads/simon/mbed.gif|mbed Logo|200}} {{/media/uploads/simon/mbed.gif|mbed Logo|200|100}}
Gallery¶
The size argument can be either small or medium, default is large.
<<gallery size=small>> {{/media/img/mbed.gif}} {{/media/img/mbed.gif|mbed logo}} [[http://mbed.org|{{/media/img/mbed.gif}}]] [[http://mbed.org|{{/media/img/mbed.gif|mbed logo}}]] <</gallery>>
Table of Contents¶
The table of contents is included in every wiki by default.If you feel you do not need the TOC then simply insert
<<notoc>>
to prevent the table of contents being displayed in the page.
Image Links¶
[[http://mbed.org|{{/media/uploads/simon/mbed.gif}}]] [[http://mbed.org|{{/media/uploads/simon/mbed.gif|mbed Website}}]]
Videos¶
{{http://www.youtube.com/watch?v=Y6kECR7T4LY}}
Tables¶
|=Column 1 |=Column 2 |=Column 3 | |Some text | in a | table |
Column 1 | Column 2 | Column 3 |
---|---|---|
Some text | in a | table |
Code¶
<<code>> int max(int x, int y) { return (x > y) ? x : y; } <</code>>
int max(int x, int y) { return (x > y) ? x : y; }
<<code main.cpp>> #include "mbed.h" int main() { printf("Hello World!\n"); } <</code>>
main.cpp
#include "mbed.h" int main() { printf("Hello World!\n"); }
Quotes¶
<<quote>> This is something very interesting... <</quote>>
Quote:
This is something very interesting...
<<quote simon>> This is something simon said... <</quote>>
wrote:
This is something simon said...
Programs¶
You can embed a published program in a wikipage:
<<program http://mbed.org/users/shintamainjp/programs/SG12864A/60ah4/>>
Import librarySG12864A
SG12864A
You can also link to a specific item of documentation about a program:
<<program http://mbed.org/users/shintamainjp/programs/SG12864A/60ah4/docs/classSG12864A.html>>
Import library
Public Types |
|
enum | Target |
Target of a chip. More... |
|
Public Member Functions |
|
SG12864A (PinName di, PinName rw, PinName en, PinName db0, PinName db1, PinName db2, PinName db3, PinName db4, PinName db5, PinName db6, PinName db7, PinName cs1, PinName cs2, PinName res) | |
Create.
|
|
~SG12864A () | |
Destroy.
|
|
void | bufferPush (void) |
Push images from a internal buffer.
|
|
void | bufferPull (void) |
Pull images to a internal buffer.
|
|
void | bufferClear (bool reverse=false) |
Clear a internal buffer images.
|
|
void | bufferDrawLine (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, bool reverse=false) |
Draw a line to a internal buffer.
|
|
void | bufferDrawBox (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, bool reverse=false) |
Draw a box to a internal buffer.
|
|
void | bufferFillBox (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, bool reverse=false) |
Fill a box to a internal buffer.
|
|
void | bufferDrawString (uint8_t x, uint8_t y, char *str, bool reverse=false) |
Draw a text string to a internal buffer.
|
|
void | bufferDrawChar (uint8_t x, uint8_t y, char c, bool reverse=false) |
Draw a character to a internal buffer.
|
|
void | bufferDrawCheckbox (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, bool state, bool reverse=false) |
Draw a checkbox to a internal buffer.
|
|
void | bufferDrawProgressbar (uint16_t x1, uint16_t y1, uint16_t x2, uint16_t y2, int min, int max, int value, bool reverse=false) |
Draw a progressbar to a internal buffer.
|
|
void | reset (void) |
Reset module.
|
|
void | clear (void) |
Clear display.
|
|
void | setDisplayOnOff ( Target t, bool on) |
Set display ON/OFF.
|
|
void | setDisplayStartLine ( Target t, uint8_t displayStartLine) |
Set display start line.
|
|
void | setPageAddress ( Target t, uint8_t addr) |
Set page address.
|
|
void | setColumnAddress ( Target t, uint8_t addr) |
Set column address.
|
|
void | readStatus ( Target t, uint8_t *c) |
Read status.
|
|
void | writeData ( Target t, uint8_t c) |
Write data.
|
|
void | readData ( Target t, uint8_t *c) |
Read data.
|
Flashboxes¶
Flashbox types: info
, help
, error
, warning
, success
, note
<<info>> This is something that might be useful... <</info>>
Information
This is something that might be useful...
<<warning title="Troubleshooting!">> Some help with troubleshooting <</warning>>
Troubleshooting!
Some help with troubleshooting
Escaping Markup¶
{{{ plain text <<code>> not **formatted** by the wiki engine }}}
plain text <<code>> not **formatted** by the wiki engine
~# hello
# hello
<<comment>> something not rendered in the output <</comment>>
(nothing!)