diff --git a/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc b/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc index d24aa95c7..698db8cc6 100644 --- a/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc +++ b/AsciiDoc_sample/AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary.adoc @@ -3,7 +3,7 @@ // This is a documentation file for authors and editors of the Arduino Manutius content platform. // Below you can find a list of all the possible page elements with the corresponding -// AsciiDoc syntax +// AsciiDoc syntax // GENERAL GUIDELINES @@ -99,10 +99,10 @@ mailto:webmaster@arduino.cc[This is an e-mail link] This is `code` in a sentence + `This is a whole line of code` + -// HINT: Please note that sometimes when copy-pasting code a few spaces can be added at the beginnng of each line of code. +// HINT: Please note that sometimes when copy-pasting code a few spaces can be added at the beginnng of each line of code. // If that happens, please remove the extra spaces. Thanks! -This can be a lot more code +This can be a lot more code [source,arduino] ---- for (int 1; i<=99; i++) { @@ -115,7 +115,7 @@ for (int 1; i<=99; i++) { // TABLES |=== -|Name of Column 1 |Name of Column 2 |Name of Column 3 +|Name of Column 1 |Name of Column 2 |Name of Column 3 |Cell in column 1, row 1 |Cell in column 2, row 1 @@ -135,7 +135,7 @@ for (int 1; i<=99; i++) { // IMAGES -// If you need to add an image to the Asciidoc please create a folder called 'attachments' in the same directory as the Asciidoc file, +// If you need to add an image to the Asciidoc please create a folder called 'attachments' in the same directory as the Asciidoc file, // place the image there and reference it as shown below. Images can be in SVG and PNG format, max size 200KB. // 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 [] diff --git a/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc b/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc index 618fd018c..c0c06e710 100644 --- a/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc +++ b/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc @@ -1,6 +1,6 @@ --- title: Parent of Entity Title -categories: [ "Functions" ] +categories: [ "Functions" ] subCategories: [ "Subcategory Name" ] --- // ARDUINO LANGUAGE REFERENCE TAG (above) ►►►►► ALWAYS INCLUDE IN YOUR FILE ◄◄◄◄◄ @@ -78,7 +78,7 @@ http://arduino.cc[serialEvent()] [float] === See also -// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), +// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), // definitions (please add the tag #DEFINITION#), and examples of Projects and Tutorials // (please add the tag #EXAMPLE#) ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ diff --git a/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc b/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc index 97b329f19..8aed8ecf3 100644 --- a/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc +++ b/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc @@ -106,7 +106,7 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption=" [float] === See also -// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), +// Link relevant content by category, such as other Reference terms (please add the tag #LANGUAGE#), // definitions: (please add the tag #DEFINITION#), and examples of Projects and Tutorials // examples: (please add the tag #EXAMPLE#) @@ -116,7 +116,7 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption=" // use the syntax shown below. Please note that the file format is subsituted by attribute. // Please note that you always need to replace spaces that you might find in folder/file names with %20 // The entire link to Reference pages must be lower case, regardless of the case of the folders and files in this repository. -// For language tag, items will be automatically generated for any other item of the same subcategory, +// For language tag, items will be automatically generated for any other item of the same subcategory, // no need to add links to other pages of the same subcategory // if you don't include this section, a minimal version with only the other pages of the same subcategory will be generated. * #LANGUAGE# link:../AsciiDoc_Template-Parent_Of_Entities[Parent Of Entities] diff --git a/Language/Functions/Analog IO/analogRead.adoc b/Language/Functions/Analog IO/analogRead.adoc index 3e4692d33..ef4ae36a4 100644 --- a/Language/Functions/Analog IO/analogRead.adoc +++ b/Language/Functions/Analog IO/analogRead.adoc @@ -12,7 +12,7 @@ subCategories: [ "Analog I/O" ] [float] === Description -Reads the value from the specified analog pin. Arduino boards contain a multichannel, 10-bit analog to digital converter. This means that it will map input voltages between 0 and the operating voltage(5V or 3.3V) into integer values between 0 and 1023. On an Arduino UNO, for example, this yields a resolution between readings of: 5 volts / 1024 units or, 0.0049 volts (4.9 mV) per unit. See the table below for the usable pins, operating voltage and maximum resolution for some Arduino boards. +Reads the value from the specified analog pin. Arduino boards contain a multichannel, 10-bit analog to digital converter. This means that it will map input voltages between 0 and the operating voltage(5V or 3.3V) into integer values between 0 and 1023. On an Arduino UNO, for example, this yields a resolution between readings of: 5 volts / 1024 units or, 0.0049 volts (4.9 mV) per unit. See the table below for the usable pins, operating voltage and maximum resolution for some Arduino boards. The input range can be changed using link:../analogreference[analogReference()], while the resolution can be changed (only for Zero, Due and MKR boards) using link:../../zero-due-mkr-family/analogreadresolution[analogReadResolution()]. diff --git a/Language/Functions/Characters/isAlpha.adoc b/Language/Functions/Characters/isAlpha.adoc index ce784d2b7..cf33bba24 100644 --- a/Language/Functions/Characters/isAlpha.adoc +++ b/Language/Functions/Characters/isAlpha.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is alpha (that is a letter). Returns true if thisChar contains a letter. +Analyse if a char is alpha (that is a letter). Returns true if thisChar contains a letter. [%hardbreaks] diff --git a/Language/Functions/Characters/isAlphaNumeric.adoc b/Language/Functions/Characters/isAlphaNumeric.adoc index 0207239c3..79a2a0af4 100644 --- a/Language/Functions/Characters/isAlphaNumeric.adoc +++ b/Language/Functions/Characters/isAlphaNumeric.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is alphanumeric (that is a letter or a numbers). Returns true if thisChar contains either a number or a letter. +Analyse if a char is alphanumeric (that is a letter or a numbers). Returns true if thisChar contains either a number or a letter. [%hardbreaks] diff --git a/Language/Functions/Characters/isAscii.adoc b/Language/Functions/Characters/isAscii.adoc index 4000f7539..2631ae2db 100644 --- a/Language/Functions/Characters/isAscii.adoc +++ b/Language/Functions/Characters/isAscii.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is Ascii. Returns true if thisChar contains an Ascii character. +Analyse if a char is Ascii. Returns true if thisChar contains an Ascii character. [%hardbreaks] diff --git a/Language/Functions/Characters/isControl.adoc b/Language/Functions/Characters/isControl.adoc index 3b7a74bb0..2b8bde222 100644 --- a/Language/Functions/Characters/isControl.adoc +++ b/Language/Functions/Characters/isControl.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is a control character. Returns true if thisChar is a control character. +Analyse if a char is a control character. Returns true if thisChar is a control character. [%hardbreaks] diff --git a/Language/Functions/Characters/isDigit.adoc b/Language/Functions/Characters/isDigit.adoc index 8ded347fb..937f9a735 100644 --- a/Language/Functions/Characters/isDigit.adoc +++ b/Language/Functions/Characters/isDigit.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is a digit (that is a number). Returns true if thisChar is a number. +Analyse if a char is a digit (that is a number). Returns true if thisChar is a number. [%hardbreaks] diff --git a/Language/Functions/Characters/isGraph.adoc b/Language/Functions/Characters/isGraph.adoc index fbc0d2f5d..c09a1143c 100644 --- a/Language/Functions/Characters/isGraph.adoc +++ b/Language/Functions/Characters/isGraph.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is printable with some content (space is printable but has no content). Returns true if thisChar is printable. +Analyse if a char is printable with some content (space is printable but has no content). Returns true if thisChar is printable. [%hardbreaks] diff --git a/Language/Functions/Characters/isHexadecimalDigit.adoc b/Language/Functions/Characters/isHexadecimalDigit.adoc index 04f75447e..be5a35310 100644 --- a/Language/Functions/Characters/isHexadecimalDigit.adoc +++ b/Language/Functions/Characters/isHexadecimalDigit.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is an hexadecimal digit (A-F, 0-9). Returns true if thisChar contains an hexadecimal digit. +Analyse if a char is an hexadecimal digit (A-F, 0-9). Returns true if thisChar contains an hexadecimal digit. [%hardbreaks] diff --git a/Language/Functions/Characters/isLowerCase.adoc b/Language/Functions/Characters/isLowerCase.adoc index e1f19c761..e3ac4c633 100644 --- a/Language/Functions/Characters/isLowerCase.adoc +++ b/Language/Functions/Characters/isLowerCase.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is lower case (that is a letter in lower case). Returns true if thisChar contains a letter in lower case. +Analyse if a char is lower case (that is a letter in lower case). Returns true if thisChar contains a letter in lower case. [%hardbreaks] diff --git a/Language/Functions/Characters/isPrintable.adoc b/Language/Functions/Characters/isPrintable.adoc index 161bc1134..8e416574e 100644 --- a/Language/Functions/Characters/isPrintable.adoc +++ b/Language/Functions/Characters/isPrintable.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is printable (that is any character that produces an output, even a blank space). Returns true if thisChar is printable. +Analyse if a char is printable (that is any character that produces an output, even a blank space). Returns true if thisChar is printable. [%hardbreaks] diff --git a/Language/Functions/Characters/isPunct.adoc b/Language/Functions/Characters/isPunct.adoc index ba4487805..c7f76c7c2 100644 --- a/Language/Functions/Characters/isPunct.adoc +++ b/Language/Functions/Characters/isPunct.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is punctuation (that is a comma, a semicolon, an exlamation mark and so on). Returns true if thisChar is punctuation. +Analyse if a char is punctuation (that is a comma, a semicolon, an exlamation mark and so on). Returns true if thisChar is punctuation. [%hardbreaks] diff --git a/Language/Functions/Characters/isSpace.adoc b/Language/Functions/Characters/isSpace.adoc index 6ec5326e1..fa6c8ab6b 100644 --- a/Language/Functions/Characters/isSpace.adoc +++ b/Language/Functions/Characters/isSpace.adoc @@ -17,7 +17,7 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is the space character. Returns true if thisChar contains the space character. +Analyse if a char is the space character. Returns true if thisChar contains the space character. [%hardbreaks] diff --git a/Language/Functions/Characters/isWhitespace.adoc b/Language/Functions/Characters/isWhitespace.adoc index 23cdc2941..c8b31ac4f 100644 --- a/Language/Functions/Characters/isWhitespace.adoc +++ b/Language/Functions/Characters/isWhitespace.adoc @@ -17,8 +17,8 @@ subCategories: [ "Characters" ] [float] === Description -Analyse if a char is a white space, that is space, formfeed ('\f'), newline ('\n'), carriage return ('\r'), horizontal tab ('\t'), and vertical tab ('\v')). -Returns true if thisChar contains a white space. +Analyse if a char is a white space, that is space, formfeed ('\f'), newline ('\n'), carriage return ('\r'), horizontal tab ('\t'), and vertical tab ('\v')). +Returns true if thisChar contains a white space. [%hardbreaks] diff --git a/Language/Functions/Communication/Serial/available.adoc b/Language/Functions/Communication/Serial/available.adoc index 69a3c680e..d6188e3a4 100644 --- a/Language/Functions/Communication/Serial/available.adoc +++ b/Language/Functions/Communication/Serial/available.adoc @@ -37,7 +37,7 @@ The number of bytes available to read . [float] === Example Code // Describe what the example code is all about and add relevant code ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ -The following code returns a character received through the serial port. +The following code returns a character received through the serial port. [source,arduino] ---- diff --git a/Language/Functions/Communication/Serial/print.adoc b/Language/Functions/Communication/Serial/print.adoc index 8edbf084a..7c3b6258f 100644 --- a/Language/Functions/Communication/Serial/print.adoc +++ b/Language/Functions/Communication/Serial/print.adoc @@ -19,7 +19,7 @@ Prints data to the serial port as human-readable ASCII text. This command can ta * `Serial.print(78)` gives "78" + * `Serial.print(1.23456)` gives "1.23" + * `Serial.print('N')` gives "N" + -* `Serial.print("Hello world.")` gives "Hello world." +* `Serial.print("Hello world.")` gives "Hello world." An optional second parameter specifies the base (format) to use; permitted values are `BIN(binary, or base 2)`, `OCT(octal, or base 8)`, `DEC(decimal, or base 10)`, `HEX(hexadecimal, or base 16)`. For floating point numbers, this parameter specifies the number of decimal places to use. For example- diff --git a/Language/Functions/External Interrupts/attachInterrupt.adoc b/Language/Functions/External Interrupts/attachInterrupt.adoc index a9c3630eb..27335982c 100644 --- a/Language/Functions/External Interrupts/attachInterrupt.adoc +++ b/Language/Functions/External Interrupts/attachInterrupt.adoc @@ -21,7 +21,7 @@ The first parameter to `attachInterrupt()` is an interrupt number. Normally you |=================================================== |Board |Digital Pins Usable For Interrupts |Uno, Nano, Mini, other 328-based |2, 3 -|Uno WiFi Rev.2 |all digital pins +|Uno WiFi Rev.2 |all digital pins |Mega, Mega2560, MegaADK |2, 3, 18, 19, 20, 21 |Micro, Leonardo, other 32u4-based |0, 1, 2, 3, 7 |Zero |all digital pins, except 4 diff --git a/Language/Functions/Random Numbers/randomSeed.adoc b/Language/Functions/Random Numbers/randomSeed.adoc index ce2f145b4..f215d6337 100644 --- a/Language/Functions/Random Numbers/randomSeed.adoc +++ b/Language/Functions/Random Numbers/randomSeed.adoc @@ -49,7 +49,7 @@ Nothing [float] === Example Code // Describe what the example code is all about and add relevant code ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ -The code generates a pseudo-random number and sends the generated number to the serial port. +The code generates a pseudo-random number and sends the generated number to the serial port. [source,arduino] ---- diff --git a/Language/Functions/Time/delayMicroseconds.adoc b/Language/Functions/Time/delayMicroseconds.adoc index 88f9867d2..628b500a3 100644 --- a/Language/Functions/Time/delayMicroseconds.adoc +++ b/Language/Functions/Time/delayMicroseconds.adoc @@ -49,7 +49,7 @@ Nothing [float] === Example Code // Describe what the example code is all about and add relevant code ►►►►► THIS SECTION IS MANDATORY ◄◄◄◄◄ -The code configures pin number 8 to work as an output pin. It sends a train of pulses of approximately 100 microseconds period. The approximation is due to execution of the other instructions in the code. +The code configures pin number 8 to work as an output pin. It sends a train of pulses of approximately 100 microseconds period. The approximation is due to execution of the other instructions in the code. [source,arduino] ---- diff --git a/Language/Structure/Comparison Operators/greaterThan.adoc b/Language/Structure/Comparison Operators/greaterThan.adoc index 1a05315ec..e4f819e36 100644 --- a/Language/Structure/Comparison Operators/greaterThan.adoc +++ b/Language/Structure/Comparison Operators/greaterThan.adoc @@ -56,7 +56,7 @@ if (x > y) { // tests if x is greater (bigger) than y [float] === Notes and Warnings -Positive numbers are greater than negative numbers. +Positive numbers are greater than negative numbers. [%hardbreaks] -- diff --git a/Language/Structure/Comparison Operators/greaterThanOrEqualTo.adoc b/Language/Structure/Comparison Operators/greaterThanOrEqualTo.adoc index cb57a5c0b..6ed4f1980 100644 --- a/Language/Structure/Comparison Operators/greaterThanOrEqualTo.adoc +++ b/Language/Structure/Comparison Operators/greaterThanOrEqualTo.adoc @@ -56,7 +56,7 @@ if (x >= y) { // tests if x is greater (bigger) than or equal to y [float] === Notes and Warnings -Positive numbers are greater than negative numbers. +Positive numbers are greater than negative numbers. [%hardbreaks] -- diff --git a/Language/Structure/Comparison Operators/lessThan.adoc b/Language/Structure/Comparison Operators/lessThan.adoc index 8e3d0068d..94f99099a 100644 --- a/Language/Structure/Comparison Operators/lessThan.adoc +++ b/Language/Structure/Comparison Operators/lessThan.adoc @@ -56,7 +56,7 @@ if (x < y) { // tests if x is less (smaller) than y [float] === Notes and Warnings -Negative numbers are less than positive numbers. +Negative numbers are less than positive numbers. [%hardbreaks] -- diff --git a/Language/Structure/Comparison Operators/lessThanOrEqualTo.adoc b/Language/Structure/Comparison Operators/lessThanOrEqualTo.adoc index e3a73b08c..95080309a 100644 --- a/Language/Structure/Comparison Operators/lessThanOrEqualTo.adoc +++ b/Language/Structure/Comparison Operators/lessThanOrEqualTo.adoc @@ -56,7 +56,7 @@ if (x <= y) { // tests if x is less (smaller) than or equal to y [float] === Notes and Warnings -Negative numbers are smaller than positive numbers. +Negative numbers are smaller than positive numbers. [%hardbreaks] -- diff --git a/Language/Variables/Utilities/sizeof.adoc b/Language/Variables/Utilities/sizeof.adoc index 32f2984a0..bfb6eafde 100644 --- a/Language/Variables/Utilities/sizeof.adoc +++ b/Language/Variables/Utilities/sizeof.adoc @@ -66,7 +66,7 @@ void loop() { [float] === Notes and Warnings -Note that `sizeof` returns the total number of bytes. So for arrays of larger variable types such as ints, the for loop would look something like this. +Note that `sizeof` returns the total number of bytes. So for arrays of larger variable types such as ints, the for loop would look something like this. [source,arduino] ---- diff --git a/Language/Variables/Variable Scope & Qualifiers/scope.adoc b/Language/Variables/Variable Scope & Qualifiers/scope.adoc index 58a10db5b..d2501ea61 100644 --- a/Language/Variables/Variable Scope & Qualifiers/scope.adoc +++ b/Language/Variables/Variable Scope & Qualifiers/scope.adoc @@ -23,7 +23,7 @@ A global variable is one that can be seen by every function in a program. Local When programs start to get larger and more complex, local variables are a useful way to insure that only one function has access to its own variables. This prevents programming errors when one function inadvertently modifies variables used by another function. -It is also sometimes handy to declare and initialize a variable inside a `for` loop. This creates a variable that can only be accessed from inside the for-loop brackets. +It is also sometimes handy to declare and initialize a variable inside a `for` loop. This creates a variable that can only be accessed from inside the for-loop brackets. [%hardbreaks] -- diff --git a/Language/Variables/Variable Scope & Qualifiers/static.adoc b/Language/Variables/Variable Scope & Qualifiers/static.adoc index d9845d54d..ef30d90d1 100644 --- a/Language/Variables/Variable Scope & Qualifiers/static.adoc +++ b/Language/Variables/Variable Scope & Qualifiers/static.adoc @@ -15,7 +15,7 @@ subCategories: [ "Variable Scope & Qualifiers" ] === Description The `static` keyword is used to create variables that are visible to only one function. However unlike local variables that get created and destroyed every time a function is called, static variables persist beyond the function call, preserving their data between function calls. -Variables declared as static will only be created and initialized the first time a function is called. +Variables declared as static will only be created and initialized the first time a function is called. [%hardbreaks] --