Skip to content

Commit 0802780

Browse files
author
smellai
committed
first commit
0 parents  commit 0802780

File tree

225 files changed

+15275
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

225 files changed

+15275
-0
lines changed

Diff for: ‎AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc

+187
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
// ARDUINO PYGMENTS HIGHLIGHT ATTRIBUTE ►►►►► ALWAYS INCLUDE IN YOUR FILE ◄◄◄◄◄
2+
:source-highlighter: pygments
3+
:pygments-style: arduino
4+
5+
// This is a documentation file for authors and editors of the Arduino Manutius content platform.
6+
// Below you can find a list of all the possible page elements with the corresponding
7+
// AsciiDoc syntax
8+
9+
10+
// GENERAL GUIDELINES
11+
// The [space]+ sends text to a new line, aka it generates a <br> in the HTML output, e.g.:
12+
// This is some text. +
13+
// This is some other text in a new line
14+
15+
// The [%hardbreaks] generates a new <p> paragraph, e.g.:
16+
// This is a <p> paragraph
17+
// [%hardbreaks]
18+
// This is another <p> paragraph
19+
20+
// If you need to add a blank line between sections of the page you can use:
21+
// {empty} +
22+
23+
// Using [%hardbreaks] at the end of a chunk is always a good practice.
24+
// [%hardbreaks] close the HTML tags, making the HTML output clean.
25+
26+
// This ''' is a line divider
27+
28+
29+
// PAGE TITLE
30+
= Page Title [h1]
31+
32+
// SECTION DIV WITH ID STARTS
33+
[#name_of_id]
34+
--
35+
36+
// Add your content here.
37+
38+
// In case your output is an HTML file, this tag will create a wrapper div with the id specified, e.g.:
39+
// <div id="name_of_id" class="openblock"></div>
40+
41+
--
42+
// SECTION DIV WITH ID ENDS
43+
44+
45+
// OTHER TITLES
46+
[float]
47+
== Section Title [h2]
48+
49+
[float]
50+
=== Paragraph Title [h3]
51+
52+
[float]
53+
==== Sub-paragraph Title [h4]
54+
55+
56+
'''
57+
58+
// TEXT STYLES
59+
This is normal <p> text +
60+
*This is bold <strong> text* +
61+
_This is italic <em> text_ +
62+
*_This is bold+italic <strong><em> text_* +
63+
[small]#This is small <span class="small"> text# +
64+
#This is highlighted <mark> text# +
65+
'`This is single quoted text`' +
66+
"`This is double quoted text`"
67+
[%hardbreaks]
68+
69+
'''
70+
71+
// LINKS
72+
// Please note that all external links need to be opened in a new window/tab by adding ^ right before the last square brackets
73+
http://arduino.cc[This is an external <a href> link^] in a new tab +
74+
link:../index.html[This is a relative <a href> link] +
75+
mailto:[email protected][This is an e-mail link]
76+
[%hardbreaks]
77+
78+
'''
79+
80+
// LISTS
81+
* This
82+
* is
83+
** an
84+
*** unordered
85+
* list
86+
87+
[%hardbreaks]
88+
89+
. This
90+
. is
91+
.. a
92+
.. n
93+
... orde
94+
... red
95+
. list
96+
97+
'''
98+
99+
// CODE
100+
This is `code` in a sentence +
101+
`This is a whole line of code` +
102+
103+
// HINT: Please note that sometimes when copy-pasting code a few spaces can be added at the beginnng of each line of code.
104+
// If that happens, please remove the extra spaces. Thanks!
105+
106+
This can be a lot more code
107+
[source,arduino]
108+
----
109+
for (int 1; i<=99; i++) {
110+
Serial.println('We want more code!');
111+
}
112+
----
113+
[%hardbreaks]
114+
115+
'''
116+
117+
// TABLES
118+
|===
119+
|Name of Column 1 |Name of Column 2 |Name of Column 3
120+
121+
|Cell in column 1, row 1
122+
|Cell in column 2, row 1
123+
|Cell in column 3, row 1
124+
125+
|Cell in column 1, row 2
126+
|Cell in column 2, row 2
127+
|Cell in column 3, row 2
128+
129+
|Cell in column 1, row 3
130+
|Cell in column 2, row 3
131+
|Cell in column 3, row 3
132+
|===
133+
[%hardbreaks]
134+
135+
'''
136+
137+
// IMAGES
138+
139+
// If you need to add an image to the Asciidoc please create a folder called 'attachments' in the same directory as the Asciidoc file,
140+
// place the image there and reference it as shown below. Images can be in SVG and PNG format, max size 200KB.
141+
142+
// To include an image on its own line (i.e., a block image), use the image:: prefix in front of the file name and square brackets after it []
143+
// Make sure you add [%hardbreaks] between any text and the image
144+
145+
This is a block image with a URL
146+
[%hardbreaks]
147+
image::http://store.arduino.cc/bmz_cache/b/babe9d3f8563ea2f170dd55539f06310.image.538x354.jpg[]
148+
149+
150+
This is an image saved in the attachments folder with a caption
151+
[%hardbreaks]
152+
image::attachments/ArduinoUno_R3_Front_450px.jpg[caption="", title="A beautiful Arduino UNO"]
153+
154+
155+
'''
156+
157+
// EMBED
158+
159+
This is a pretty embed of code from Gist
160+
++++
161+
<script src="http://gist.github.com/mojavelinux/5333524.js">
162+
</script>
163+
++++
164+
165+
{empty} +
166+
167+
And this is another of a video from YouTube
168+
++++
169+
<iframe width="100%" height="315" src="http://www.youtube-nocookie.com/embed/UoBUXOOdLXY?rel=0&amp;controls=0&amp;showinfo=0" frameborder="0" allowfullscreen></iframe>
170+
++++
171+
// HINT: Please remember to set the iframe width to 100% to have the video responsive on all our platforms
172+
173+
{empty} +
174+
175+
And here some slides from Sideshare, yay!
176+
++++
177+
<iframe src="http://www.slideshare.net/slideshow/embed_code/4430242" width="100%" height="355" frameborder="0" marginwidth="0" marginheight="0" scrolling="no" style="border:1px solid #CCC; border-width:1px; margin-bottom:5px; max-width: 100%;" allowfullscreen> </iframe> <div style="margin-bottom:5px"> <strong> <a href="//www.slideshare.net/damellis/introduction-to-arduino-4430242" title="Introduction to Arduino" target="_blank">Introduction to Arduino</a> </strong> from <strong><a href="//www.slideshare.net/damellis" target="_blank">David Mellis</a></strong> </div>
178+
++++
179+
// HINT: Please remember to set the iframe width to 100% to have the slide show responsive on all our platforms
180+
181+
{empty} +
182+
183+
And this is some audio from SoundCloud
184+
++++
185+
<iframe width="100%" height="450" scrolling="no" frameborder="no" src="https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/playlists/55323777&amp;auto_play=false&amp;hide_related=false&amp;show_comments=true&amp;show_user=true&amp;show_reposts=false&amp;visual=true"></iframe>
186+
++++
187+
// HINT: Please remember to set the iframe width to 100% to have the sound UI responsive on all our platforms

Diff for: ‎AsciiDoc_sample/AsciiDoc_Dictionary/attachments/ArduinoUno_R3_Front_450px.jpg

137 KB
Loading

Diff for: ‎AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
title: Parent of Entity Title
3+
categories: [ "Functions" ]
4+
subCategories: [ "Subcategory Name" ]
5+
---
6+
// ARDUINO LANGUAGE REFERENCE TAG (above) ►►►►► ALWAYS INCLUDE IN YOUR FILE ◄◄◄◄◄
7+
// title will show up in the Index of all Reference terms
8+
// categories: Pick between Structure, Variable or Function
9+
// The subcategory within the ones available in the index ("Digital I/O", "Arithmetic Operators")
10+
11+
// ARDUINO PYGMENTS HIGHLIGHT ATTRIBUTE ►►►►► ALWAYS INCLUDE IN YOUR FILE ◄◄◄◄◄
12+
:source-highlighter: pygments
13+
:pygments-style: arduino
14+
15+
16+
// PAGE TITLE ►►►►► THIS IS MANDATORY ◄◄◄◄◄
17+
= Parent of Entities title()
18+
19+
20+
// OVERVIEW SECTION STARTS
21+
[#overview]
22+
--
23+
24+
[float]
25+
=== Description
26+
// Describe what this group of Reference terms is used for, -- THIS SECTION IS MANDATORY --
27+
Used for communication between the Arduino board and a computer or other devices. All Arduino boards have at least one serial port (also known as a UART or USART): Serial. It communicates on digital pins 0 (RX) and 1 (TX) as well as with the computer via USB. Thus, if you use these functions, you cannot also use pins 0 and 1 for digital input or output. +
28+
You can use the Arduino environment's built-in serial monitor to communicate with an Arduino board. Click the serial monitor button in the toolbar and select the same baud rate used in the call to `begin()`.
29+
[%hardbreaks]
30+
The *Arduino Mega* has three additional serial ports: `Serial1` on pins 19 (RX) and 18 (TX), `Serial2` on pins 17 (RX) and 16 (TX), `Serial3` on pins 15 (RX) and 14 (TX). To use these pins to communicate with your personal computer, you will need an additional USB-to-serial adaptor, as they are not connected to the Mega's USB-to-serial adaptor. To use them to communicate with an external TTL serial device, connect the TX pin to your device's RX pin, the RX to your device's TX pin, and the ground of your Mega to your device's ground. (Don't connect these pins directly to an RS232 serial port; they operate at +/- 12V and can damage your Arduino board.)
31+
[%hardbreaks]
32+
The *Arduino DUE* has three additional 3.3V TTL serial ports: `Serial1` on pins 19 (RX) and 18 (TX); `Serial2` on pins 17 (RX) and 16 (TX), `Serial3` on pins 15 (RX) and 14 (TX). Pins 0 and 1 are also connected to the corresponding pins of the ATmega16U2 USB-to-TTL Serial chip, which is connected to the USB debug port. Additionally, there is a native USB-serial port on the SAM3X chip, SerialUSB'.
33+
[%hardbreaks]
34+
The *Arduino Leonardo* board uses `Serial1` to communicate via TTL (5V) serial on pins 0 (RX) and 1 (TX). `Serial` is reserved for USB CDC communication. For more information, refer to the Leonardo getting started page and hardware page.
35+
36+
--
37+
// OVERVIEW SECTION ENDS
38+
39+
40+
41+
42+
// FUNCTIONS SECTION STARTS
43+
[#functions]
44+
--
45+
46+
'''
47+
48+
[float]
49+
=== Functions
50+
// List all the functions within this Reference parent, ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
51+
http://arduino.cc[if] (Serial) +
52+
http://arduino.cc[available()] +
53+
http://arduino.cc[begin()] +
54+
http://arduino.cc[end()] +
55+
http://arduino.cc[find()] +
56+
http://arduino.cc[findUntil()] +
57+
http://arduino.cc[flush()] +
58+
http://arduino.cc[parseFloat()] +
59+
http://arduino.cc[parseInt()] +
60+
http://arduino.cc[peek()] +
61+
http://arduino.cc[print()] +
62+
http://arduino.cc[println()] +
63+
http://arduino.cc[read()] +
64+
http://arduino.cc[readBytes()] +
65+
http://arduino.cc[readBytesUntil()] +
66+
http://arduino.cc[setTimeout()] +
67+
http://arduino.cc[write()] +
68+
http://arduino.cc[serialEvent()]
69+
70+
'''
71+
72+
--
73+
// FUNCTIONS SECTION ENDS
74+
75+
76+
// SEE ALSO SECTION STARTS
77+
[#seealso]
78+
--
79+
80+
[float]
81+
=== See also
82+
// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#),
83+
// definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials
84+
// (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄
85+
86+
87+
[role="language"]
88+
// Whenever you want to link to another Reference term, or more in general to a relative link,
89+
// use the syntax shown below. Please note that the file format is subsituted by attribute.
90+
// Please note that you always need to replace spaces that you might find in folder/file names with %20
91+
* #LANGUAGE# link:../AsciiDoc_Template-Single_Entity[Single Entity]
92+
* #LANGUAGE# link:../../AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary[AsciiDoc Template Dictionary]
93+
94+
[role="definition"]
95+
// Please note that all external links need to be opened in a new window/tab by adding ^ right before the last square brackets
96+
* #DEFINITION# http://arduino.cc/en/Tutorial/PWM[PWM^]
97+
98+
[role="example"]
99+
// Please note that all external links need to be opened in a new window/tab by adding ^ right before the last square brackets
100+
* #EXAMPLE# http://arduino.cc/en/Tutorial/Blink[Blink^]
101+
102+
--
103+
// SEE ALSO SECTION ENDS

0 commit comments

Comments
 (0)