Skip to content

Commit 4378132

Browse files
author
Matteo Mattiuzzi
committed
review 2 Matteo, mainly initial part of the doc
1 parent f85792f commit 4378132

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

src/guidelines/editor-manual.qmd

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
2-
title: "Quarto Documentation - Editor Manual"
2+
title: "Writing Techncial Documentation for CLMS"
3+
subtitle: "Editor Manual"
4+
author: "European Environment Agency (EEA)"
5+
version: "0.3"
6+
date: "2025-04-05"
37
toc: true
48
toc-title: "Content"
5-
version: 1.0-draft
69

710
format:
811
# docx: default
@@ -15,21 +18,18 @@ format:
1518

1619
<!--# For 'whom/which process' in the CLMS context is this document? -->
1720

18-
This manual will guide you step by step through creating documentation using [**Quarto**](https://quarto.org/). Quarto is a tool that helps you write simple text using **Markdown** (a plain text format) and turn it into professional-looking documents, such as **HTML** pages or **PDF** files.
19-
20-
You don't need to be a programmer or an expert to use Quarto. If you've ever written a document in Microsoft Word, you'll be able to use Quarto with a bit of practice.
21-
22-
This manual is for people who work with documentation --- especially in teams --- and need a simple, clear, and repeatable way to create it. We will cover everything from basic Markdown writing to rendering your final documents.
23-
24-
We'll also explain the structure of your project, how to use ready-made templates, and how to avoid common mistakes.
21+
This manual guides users through creating technical documentation for the Copernicus Land Monitoring Service using [**Quarto**](https://quarto.org/). Quarto simplifies the process of writing professional documents in **Markdown**, converting them into **HTML** and **PDF** for nice publishing. The manual covers basic Markdown writing, document rendering, as well a the review, and publication process of technical CLMS documents. It also describes the project folder structure, template usage, and common mistakes to avoid.\
22+
*You don't need to be a programmer nor an expert to use Quarto. If you've ever written a document in Microsoft Word, you'll be able to use Quarto with a bit of practice.*
2523

2624
# Folder and File Structure
2725

2826
<!--# If this is for the doc part only, does it make sense to mention also the potential insertion of the doc repo in the larger project? (I am not sure, just a guess) -->
2927

28+
<!--# Document projects are typically located inside an IT project, but can exist also on their own...(something like this, just mentioning it) -->
29+
3030
In this section, we explain how the documentation project is organized and where you should put your files. This structure helps keep everything clean, consistent, and easy to work with --- especially when multiple people are involved.
3131

32-
Below is a typical folder layout for the project:
32+
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 probable naming convention CLMS_template_ATBD.qmd and CLMS_template_PUM.qmd (I wil,share the naming convention file with you soon-->
3333

3434
```
3535
project-root-doc/
@@ -41,7 +41,7 @@ project-root-doc/
4141
│ | ├── reference.docx
4242
│ | └── custom.scss
4343
| └── products/
44-
| ├── my-doc.qmd
44+
| ├── my-doc.qmd
4545
| └── my-doc-media
4646
| └── image1.png
4747
├── scripts/
@@ -95,7 +95,7 @@ In addition to this guide and the official documentation, you can also explore t
9595
9696
Markdown is a simple way to format text using plain characters --- no need for complicated tools or buttons. Quarto uses Markdown to let you write clean, readable documents that can be turned into HTML or PDF automatically.
9797
98-
This section shows the most useful Markdown elements you'll need when writing documentation. If you want to explore more, visit the official Quarto Markdown guide at <https://quarto.org/docs/authoring/markdown-basics.html>
98+
This section shows the most useful Markdown elements you'll need when writing documentation. If you want to explore more, visit the official [Quarto Markdown guide](https://quarto.org/docs/authoring/markdown-basics.html).
9999
100100
## Headings
101101
@@ -763,7 +763,9 @@ You can render your documentation directly in RStudio or using command-line tool
763763

764764
## Render to HTML
765765

766-
<!--# there is also "Render webside" under build on the top right side. if that is relevant here add a screenshot and clarify the difference between the two --> HTML is the default output format and is useful for previewing your document in a web browser while you work. Rendered HTML uses the custom Technical Library theme and includes a table of contents, clickable navigation, and consistent styles. It's a great way to check formatting, layout, and images as you write.
766+
<!--# there is also "Render webside" under build on the top right side. if that is relevant here add a screenshot and clarify the difference between the two -->
767+
768+
HTML is the default output format and is useful for previewing your document in a web browser while you work. Rendered HTML uses the custom Technical Library theme and includes a table of contents, clickable navigation, and consistent styles. It's a great way to check formatting, layout, and images as you write.
767769

768770
There are two ways to preview your `.qmd` file:
769771

0 commit comments

Comments
 (0)