You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/guidelines/editor-manual.qmd
+60-2Lines changed: 60 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,9 @@ title: "Guide for Writing Techncial Documentation"
3
3
subtitle: "Copernicus Land Monitoring Service"
4
4
author: "European Environment Agency (EEA)"
5
5
version: 0.4
6
-
description: "A comprehensive guide for creating technical documentation for the Copernicus Land Monitoring Service using Quarto. It covers Markdown basics, document rendering, and the review process, ensuring consistency and clarity in documentation."
6
+
description: "A comprehensive guide for creating technical documentation for the Copernicus
7
+
Land Monitoring Service using Quarto. It covers Markdown basics, document rendering,
8
+
and the review process, ensuring consistency and clarity in documentation."
<!--# maybe we should promote (or at least describe the option of unsing variables in yaml that can be reused in the document: e.g. product-name: "Example Product" --- # Welcome to {{ product-name }} Documentation. -->
@@ -36,7 +42,7 @@ In this section, we explain how the documentation project is organized and where
36
42
37
43
Below is a typical folder layout for the project: <!--# instead of my-doc.qmd use CLMS_my-product_ATBD.qmd we should rename the templates to better fit the planned naming convention CLMS_template_ATBD.qmd and CLMS_template_PUM.qmd (I wil,share the naming convention file with you soon-->
38
44
39
-
```
45
+
```markdown
40
46
project-root-doc/
41
47
├── src/
42
48
│ ├── templates/
@@ -134,18 +140,57 @@ This is another line.
134
140
135
141
```markdown
136
142
- Item one
143
+
137
144
- Item two
145
+
138
146
- Subitem
139
147
```
140
148
141
149
### Numbered (Ordered) List
142
150
143
151
```markdown
144
152
1. First step
153
+
145
154
2. Second step
155
+
146
156
1. Sub-step
147
157
```
148
158
159
+
::: callout-important
160
+
Make sure to include a blank line between list items, and ensure they are correctly indented. This ensures proper rendering in .docx and .pdf outputs. Without these, list entries may merge, misalign, or render incorrectly.
161
+
:::
162
+
163
+
### Paragraphs Within List Items
164
+
165
+
To include a paragraph or a block of text as part of a list item, indent the paragraph to match the indentation of the list content. Also, make sure the paragraph follows the list item without a blank line, or it may break the list.
166
+
167
+
```markdown
168
+
- This is the list item title.
169
+
This is a paragraph that belongs to the same list item.
170
+
It should be indented to align with the start of "This is a paragraph..."
171
+
172
+
- Another item
173
+
With its own paragraph block.
174
+
```
175
+
176
+
### Single-Item List Rendering Issue
177
+
178
+
When a list or sublist contains only one item, it can be incorrectly rendered in .docx or .pdf formats. In such cases, the item may appear in the wrong font or style.
179
+
180
+
To fix this, apply a custom style to the single list item. In the provided Word template, use the style named "NormalLine".
181
+
182
+
Here is how to apply it:
183
+
184
+
```markdown
185
+
- step 1
186
+
-[step 1.1]{custom-style="NormalLine"}\
187
+
```
188
+
189
+
::: callout-note
190
+
- The custom-style attribute ensures the correct formatting.
191
+
- Don't forget to include the backslash (\) at the end of the line to prevent unwanted spacing or breaks.
192
+
:::
193
+
149
194
## Links and Images
150
195
151
196
### Link
@@ -393,6 +438,19 @@ This method keeps captions aligned with each image, and works across all output
393
438
394
439
> ⚠️ **Note:** Tables used for captions will show borders in DOCX and PDF outputs. Removing them requires custom styles in a reference DOCX.
395
440
441
+
## Page Breaks for .docx/.pdf Outputs
442
+
443
+
In Quarto, using section breaks (like - - -) may not reliably produce a page break in .docx or .pdf outputs. Instead, to insert a page break that appears only in those formats, use the following block: that appears only in .docx or .pdf outputs, use the following block:
444
+
445
+
```markdown
446
+
::: {.content-visible format=docx}
447
+
```{=openxml}
448
+
<w:p><w:r><w:br w:type="page"/></w:r></w:p>
449
+
:::
450
+
```
451
+
452
+
This will ensure that the page break is included in the rendered Word or PDF document, but not visible in HTML or other formats.
453
+
396
454
## Equations
397
455
398
456
Quarto supports mathematical equations using LaTeX-style syntax. You can add inline equations or display equations as blocks.
Copy file name to clipboardExpand all lines: src/products/Riparian_Zones_Nomenclature_Guideline.qmd
+15-15Lines changed: 15 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -315,7 +315,7 @@ The minimum mapping unit defined is ≥ 0.5 ha for all objects. A minimum width
315
315
316
316
[MMW Exceptions:]{.underline}
317
317
318
-
- To maintain continuity of linear features (Codes 1.2.1.0, 1.2.2.0, 6.2.1.0, 6.2.2.0, 8.1.1.0 and 8.1.2.0); the MMW may fall below the limit of 10 m, over a distance of up to 100 m.
318
+
-[To maintain continuity of linear features (Codes 1.2.1.0, 1.2.2.0, 6.2.1.0, 6.2.2.0, 8.1.1.0 and 8.1.2.0); the MMW may fall below the limit of 10 m, over a distance of up to 100 m.]{custom-style="NormalLine"}\
319
319
320
320
**Good Practice for Data Display -- Mapping Scale:**
321
321
@@ -465,7 +465,7 @@ This category includes:
465
465
466
466
-**1.1 Urban fabric, industrial, commercial, public, military and private units**
467
467
468
-
Urban fabric contains land covered by artificial structures and transport networks. Industrial or commercial units are almost completely covered by artificial surface.
468
+
Urban fabric contains land covered by artificial structures and transport networks. Industrial or commercial units are almost completely covered by artificial surface.
469
469
470
470
- 1.1.1 Urban fabric (predominantly public and private units)
471
471
@@ -477,47 +477,47 @@ Urban fabric contains land covered by artificial structures and transport networ
477
477
478
478
- 1.1.2 Industrial, commercial and military units
479
479
480
-
- 1.1.2.0 Industrial, commercial and military units
480
+
-[1.1.2.0 Industrial, commercial and military units]{custom-style="NormalLine"}\
481
481
482
482
-**1.2 Transport infrastructure**
483
483
484
-
Motorways, roads and railways with its associated land and installations are included in this class if width \>10 m. Airports and port areas with installations and associated land are included. If an infrastructure line is crossing a river, the bridge has to be mapped if the bridge is wider than 10 m.
484
+
Motorways, roads and railways with its associated land and installations are included in this class if width \>10 m. Airports and port areas with installations and associated land are included. If an infrastructure line is crossing a river, the bridge has to be mapped if the bridge is wider than 10 m.
485
485
486
486
- 1.2.1 Road networks and associated land
487
487
488
-
- 1.2.1.0 Road networks and associated land
488
+
-[1.2.1.0 Road networks and associated land]{custom-style="NormalLine"}\
489
489
490
490
- 1.2.2 Railways and associated land
491
491
492
-
- 1.2.2.0 Railways and associated land
492
+
-[1.2.2.0 Railways and associated land]{custom-style="NormalLine"}\
493
493
494
494
- 1.2.3 Port areas and associated land
495
495
496
-
- 1.2.3.0 Port areas and associated land
496
+
-[1.2.3.0 Port areas and associated land]{custom-style="NormalLine"}\
497
497
498
498
- 1.2.4 Airports and associated land
499
499
500
-
- 1.2.4.0 Airports and associated land
500
+
-[1.2.4.0 Airports and associated land]{custom-style="NormalLine"}\
501
501
502
502
-**1.3 Mineral extraction, dump and construction sites, land without current use**
503
503
504
-
Dump sites include public, industrial or mine dump sites. Construction development, soil and bedrock excavations and earthwork are included in this class. Land without current use is land that is in transitional phase and it is included in urban areas.
504
+
Dump sites include public, industrial or mine dump sites. Construction development, soil and bedrock excavations and earthwork are included in this class. Land without current use is land that is in transitional phase and it is included in urban areas.
505
505
506
506
- 1.3.1 Mineral extraction, dump and construction sites
507
507
508
-
- 1.3.1.0 Mineral extraction, dump and construction sites
508
+
-[1.3.1.0 Mineral extraction, dump and construction sites]{custom-style="NormalLine"}\
509
509
510
510
- 1.3.2 Land without current use
511
511
512
-
- 1.3.2.0 Land without current use
512
+
-[1.3.2.0 Land without current use]{custom-style="NormalLine"}\
513
513
514
514
-**1.4 Green urban, sports and leisure facilities**
515
515
516
516
Green urban areas are areas with vegetation within the urban fabric and it includes parks. Sports and leisure facilities are included (camping grounds, sport grounds, leisure parks, golf courses, race courses, etc.). It also comprises parks not surrounded by urban areas.
517
517
518
-
- 1.4.0 Green urban, sports and leisure facilities
518
+
- 1.4.0 Green urban, sports and leisure facilities
519
519
520
-
- 1.4.0.0 Green urban, sports and leisure facilities
520
+
-[1.4.0.0 Green urban, sports and leisure facilities]{custom-style="NormalLine"}\
521
521
522
522
{{< pagebreak >}}
523
523
@@ -661,7 +661,7 @@ The build-up areas adjacent to small farms will be included in this class.
661
661
662
662
**MMW Exceptions:**
663
663
664
-
- To maintain continuity of linear features (1.2.1.0 / 1.2.2.0 / 6.2.1.0 / 6.2.2.0 / 9.1.1.0 / 9.1.2.0), the MMW may fall below the limit of 10 m over a distance of up to 100 m.
664
+
-[To maintain continuity of linear features (1.2.1.0 / 1.2.2.0 / 6.2.1.0 / 6.2.2.0 / 9.1.1.0 / 9.1.2.0), the MMW may fall below the limit of 10 m over a distance of up to 100 m.]{custom-style="NormalLine"}\
665
665
666
666
**Methodological Advice:**
667
667
@@ -4101,7 +4101,7 @@ Sand and gravel of river banks including accumulation of material at bars and fl
4101
4101
4102
4102
**MMW Exceptions:**
4103
4103
4104
-
- To maintain continuity of linear features, the MMW may fall below the limit of 10 m over a distance of up to 100 m.
4104
+
-[To maintain continuity of linear features, the MMW may fall below the limit of 10 m over a distance of up to 100 m.]{custom-style="NormalLine"}\
0 commit comments