Skip to content

Commit f4772eb

Browse files
committed
Add note to reference example pages about the need to make reference page links lower case
This is a common mistake that is very easy to make.
1 parent ee78596 commit f4772eb

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Parent_Of_Entities.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ http://arduino.cc[serialEvent()]
8787
// Whenever you want to link to another Reference term, or more in general to a relative link,
8888
// use the syntax shown below. Please note that the file format is subsituted by attribute.
8989
// Please note that you always need to replace spaces that you might find in folder/file names with %20
90+
// The entire link to Reference pages must be lower case, regardless of the case of the folders and files in this repository.
9091
* #LANGUAGE# link:../AsciiDoc_Template-Single_Entity[Single Entity]
9192
* #LANGUAGE# link:../../AsciiDoc_Dictionary/AsciiDoc_Template-Dictionary[AsciiDoc Template Dictionary]
9293

AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="
117117
// Whenever you want to link to another Reference term, or more in general to a relative link,
118118
// use the syntax shown below. Please note that the file format is subsituted by attribute.
119119
// Please note that you always need to replace spaces that you might find in folder/file names with %20
120-
// for language tag, items will be automatically generated for any other item of the same subcategory,
120+
// The entire link to Reference pages must be lower case, regardless of the case of the folders and files in this repository.
121+
// For language tag, items will be automatically generated for any other item of the same subcategory,
121122
// no need to add links to other pages of the same subcategory
122123
// if you don't include this section, a minimal version with only the other pages of the same subcategory will be generated.
123124
* #LANGUAGE# link:../AsciiDoc_Template-Parent_Of_Entities[Parent Of Entities]

0 commit comments

Comments
 (0)