Commit 585ed868 authored by Miguel Angel Reina Ortega's avatar Miguel Angel Reina Ortega
Browse files

Merge branch '2025-07-29-akr' into 'main'

Added text for table headers, images, notes

See merge request tools/specification-guidelines!1
parents ea015dd2 3d934608
Loading
Loading
Loading
Loading
+68 −25
Original line number Diff line number Diff line
@@ -28,11 +28,34 @@ Figures can be specified by adding the corresponding image file to the media fol
	
E.g. 
	
	![Figure 1.2-2: My figure title](media/figure1.png>)
	![Figure 1.2-2: My figure title](media/1.2-2.png)

	**Figure 1.2-2: My figure title**

**.png, .jpg and .svg** are supported as image files.
**.png and .jpg** are supported as image files. It is recommended to use .png files for figures, as they are lossless and provide better quality than .jpg files.

### Image Source Files

Image files **should** be drawn using a vector graphics editor and saved in an open vector format such as SVG. This allows for better scalability and quality when rendering the images in different sizes as well as easier editing in the future.

Proprietary formats such as Microsoft PowerPoint (.pptx), Adobe Illustrator (.ai) or CorelDRAW (.cdr) are not recommended, as they may not be accessible to all users and can lead to compatibility issues.

The image source files **should** be included in the media folder and named according to the naming conventions.


### Naming Conventions for Image Files

Image and image source files **should** be named according to the following convention:

	<Clause number>-<Figure number in clause>.<file extension>

e.g. `1.2-2.png` for the figure `Figure 1.2-2`.


### Diagrams

Diagrams can be specified by using UML diagrams. The recommendation is to generate the PlantUML diagram image by using any PlantUML online servers ([ETSI PlantUML server](http://tools.etsi.org/plant)), and adding both the source code (.puml) and the image files to the media folder. Then, the diagram can be added as a normal figure as described at [Figures](#-figures).


## Tables

@@ -44,20 +67,20 @@ width is justified

	E.g. 
		
	|Title 1|**Title 2**|Title 3|
		|Title 1|Title 2|Title 3|
		|-|-|-|
		|Row 1 Cell 1|Row 1 Cell 2|Row 1 Cell 3|
		|Row 2 Cell 1|Row 2 Cell 2|Row 2 Cell 3|
	
	Rendered view:

|Title 1|**Title 2**|Title 3|
	|Title 1|Title 2|Title 3|
	|-|-|-|
	|Row 1 Cell 1|Row 1 Cell 2|Row 1 Cell 3|
	|Row 2 Cell 1|Row 2 Cell 2|Row 2 Cell 3|


		
		
2. Grid tables. This kind of tables can be used for complex tables where merge cells are needed. Grid tables use separator lines between data rows (header and body). 
Separator lines are composed of "+" symbols and "-" or "=" between the "+" symbols. "="s are used to separate header and body. Columns MUST be aligned, meaning that 
position of "+" must be the same for every separator line, unless merged columns are being used. Body rows are defined as pipe tables rows, by using "|" to separate cells. 
@@ -66,7 +89,7 @@ However, separator lines can be defined for certain columns, which make possible
E.g.
		
		+------------+------------+------------+
		|Title 1     |__Title 2__ |Title 3     |
		|Title 1     |Title 2     |Title 3     |
		+============+============+============+
		|Merged      |Row 1 Cell 2|Row 1 Cell 3|
		|            +-------------------------+
@@ -75,15 +98,16 @@ E.g.
		
> Note: Grid tables are not supported by GitLab, so they will not be rendered (Work in progress to implement a filter for Gitlab markdown rendering)  

Text formatting (bold, italic, links), lists, multiline can be used in both pipe and grid tables.
Text formatting (bold, italic, links), lists, multiline can be used in both pipe and grid tables, but shall not be used in table headers. Document style sheets takes care when rendering the tables, so no additional formatting is needed and may actually be overridden by the style sheets.

Table caption **shall be used** and **shall preceed** the table (one blank line between table caption and table definition) and shall follow the format:

	**Table <Clause Number>-<Table number in clause>: <Table title>**<a name="table_<Clause number>-<Table number in clause"></a>
	
	E.g. ****Table 1.2.3-1: My nice table**<a name="table_1.2.3-1"></a>
E.g. `****Table 1.2.3-1: My nice table**<a name="table_1.2.3-1"></a>`



Alignment can be used in both pipe and grid tables by inserting ":" in the header separator lines either on the left (for left alignment) or on the right (for right alignment), default alignment is center:

	+---------------+---------------+--------------------+
@@ -96,9 +120,6 @@ More detailed information can be found at [Pandoc documentation](https://pandoc.

In addition, an online converter/checker tool is available at [Grid Table converter](http://tools.etsi.org/gridtable-ie/) to facilitate the creation of grid tables.

## Diagrams

Diagrams can be specified by using UML diagrams. The recommendation is to generate the PlantUML diagram image by using any PlantUML online servers ([ETSI PlantUML server](http://tools.etsi.org/plant)), and adding both the source code (.puml) and the image files to the media folder. Then, the diagram can be added as a normal figure as described at [Figures](#-figures).

## Formulas and Equations

@@ -133,6 +154,28 @@ More detailed information about formulas (operators, symbols, equations, ...) ca

## Notes

### Specification Notes

Specification notes **shall** be formatted as markdown notes:

	> Note: My note text

e.g.

> Note: This is a specification note that provides additional information about the topic.


### Editor Notes

Editor notes **shall** be formatted as follows:

	<mark>Editor Note: My editor note text</mark>

e.g.

<mark>Editor Note: This is an editor note that provides editorial instructions.</mark>


## Symbols

Symbols can be used into a markdown specification. More detail information can be found at [Markdown guide](https://www.markdownguide.org/hacks/#symbols). Here a list of most common