From d93c044c6f0621d0cd65881d61cac3e0632a578a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=81lvaro=20Mond=C3=A9jar=20Rubio?= Date: Sun, 21 Dec 2025 22:53:40 +0100 Subject: [PATCH] Refactor documentation about arguments --- .pre-commit-config.yaml | 14 ++--- README.md | 89 +++++++--------------------- locale/es/README.md | 128 ++++++++++++---------------------------- locale/es/README.md.po | 89 +--------------------------- locale/fr/README.md | 126 +++++++++++---------------------------- locale/fr/README.md.po | 90 +--------------------------- 6 files changed, 107 insertions(+), 429 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index c3c989f..26c9061 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/rbubley/mirrors-prettier - rev: v3.6.2 + rev: v3.7.4 hooks: - id: prettier types_or: @@ -37,14 +37,14 @@ repos: - id: end-of-file-fixer name: end-of-file-fixer - repo: https://github.com/python-jsonschema/check-jsonschema - rev: 0.33.3 + rev: 0.36.0 hooks: - id: check-github-workflows name: check-github-workflows args: - --verbose - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.12.10 + rev: v0.14.10 hooks: - id: ruff args: @@ -78,19 +78,19 @@ repos: hooks: - id: yamllint - repo: https://github.com/DavidAnson/markdownlint-cli2 - rev: v0.18.1 + rev: v0.20.0 hooks: - id: markdownlint-cli2 name: markdownlint-readme files: ^README.md - repo: https://github.com/editorconfig-checker/editorconfig-checker.python - rev: 3.4.0 + rev: 3.6.0 hooks: - id: editorconfig-checker name: editorconfig-checker alias: ec - repo: https://github.com/pre-commit/mirrors-mypy - rev: v1.17.1 + rev: v1.19.1 hooks: - id: mypy name: mypy-mkdocs-1.5.0 @@ -100,7 +100,7 @@ repos: - platformdirs - wcmatch - repo: https://github.com/pre-commit/mirrors-mypy - rev: v1.17.1 + rev: v1.19.1 hooks: - id: mypy name: mypy-mkdocs-1.6.0 diff --git a/README.md b/README.md index feff48e..ab2566d 100644 --- a/README.md +++ b/README.md @@ -146,6 +146,8 @@ plugins: This plugin provides two directives, one to include Markdown files and another to include files of any type. +#### Common arguments + Paths of included files can be either: - URLs to include remote content. @@ -164,34 +166,27 @@ single `'` quotes, which can be escaped prepending them a `\` character as The arguments **start** and **end** may contain usual (Python-style) escape sequences like `\n` to match against newlines. - - -#### **`include-markdown`** - -Includes Markdown files content, optionally using two delimiters to filter the -content to include. - -- # +- # **start**: Delimiter that marks the beginning of the content to include. -- # +- # **end**: Delimiter that marks the end of the content to include. -- # +- # **preserve-includer-indent** (_true_): When this option is enabled (default), every line of the content to include is indented with the same number of spaces used to indent the includer `{% %}` template. Possible values are `true` and `false`. -- # +- # **dedent** (_false_): If enabled, the included content will be dedented. -- # +- # **exclude**: Specify with a glob which files should be ignored. Only useful when passing globs to include multiple files. -- # +- # **trailing-newlines** (_true_): When this option is disabled, the trailing newlines found in the content to include are stripped. Possible values are `true` and `false`. -- # +- # **recursive** (_true_): When this option is disabled, included files are not processed for recursive includes. Possible values are `true` and `false`. -- # +- # **order** (_'alpha-path'_): Define the order in which multiple files are included when using globs. Possible values are: - A combination of an optional order type and an optional order by separated @@ -206,8 +201,8 @@ content to include. - `'path'` (default): Order by full file path. - `'name'`: Order by file name only. - `'extension'`: Order by file extension. - - A combination of an optional prefix hyphen to denote ascending order and - one of the following values in the form `[-]` where `` is one of: + - A combination of an optional prefix hyphen to denote ascending order and one + of the following values in the form `[-]` where `` is one of: - `'size'`: Order by file size. - `'mtime'`: Order by file modification time. - `'ctime'`: Order by file creation time (or the last metadata change time @@ -217,9 +212,17 @@ content to include. - `'system'`: Order provided by the operating system. This is the same as not specifying any order and relying on the default order of the filesystem. This may be different between operating systems, so use it with care. -- # +- # **encoding** (_'utf-8'_): Specify the encoding of the included file. If not defined `'utf-8'` will be used. + + + +#### **`include-markdown`** + +Includes Markdown files content, optionally using two delimiters to filter the +content to include. + - # **rewrite-relative-urls** (_true_): When this option is enabled (default), Markdown links and images in the content that are specified by a relative URL @@ -296,56 +299,6 @@ content to include. Includes the content of a file or a group of files. -- # - **start**: Delimiter that marks the beginning of the content to include. -- # - **end**: Delimiter that marks the end of the content to include. -- # - **preserve-includer-indent** (_true_): When this option is enabled (default), - every line of the content to include is indented with the same number of - spaces used to indent the includer `{% %}` template. Possible values are - `true` and `false`. -- # - **dedent** (_false_): If enabled, the included content will be dedented. -- # - **exclude**: Specify with a glob which files should be ignored. Only useful - when passing globs to include multiple files. -- # - **trailing-newlines** (_true_): When this option is disabled, the trailing newlines - found in the content to include are stripped. Possible values are `true` and `false`. -- # - **recursive** (_true_): When this option is disabled, included files are not - processed for recursive includes. Possible values are `true` and `false`. -- # - **order** (_'alpha-path'_): Define the order in which multiple files are included - when using globs. Possible values are: - - A combination of an optional order type and an optional order by separated - by a hyphen (`-`), and optionally prefixed by a hyphen (`-`) to indicate - ascending order. If an order type or an order by is not specified, the defaults - are used. It follows the form: - `[-]-` where: - - **Order type**: - - `'alpha'` (default): Alphabetical order. - - `'natural'`: Natural order, so that e.g. `file2.md` comes before `file10.md`. - - **Order by**: - - `'path'` (default): Order by full file path. - - `'name'`: Order by file name only. - - `'extension'`: Order by file extension. - - A combination of an optional prefix hyphen to denote ascending order and - one of the following values in the form `[-]` where `` is one of: - - `'size'`: Order by file size. - - `'mtime'`: Order by file modification time. - - `'ctime'`: Order by file creation time (or the last metadata change time - on Unix systems). - - `'atime'`: Order by file last access time. - - `'random'`: Random order. - - `'system'`: Order provided by the operating system. This is the same as not - specifying any order and relying on the default order of the filesystem. This - may be different between operating systems, so use it with care. -- # - **encoding** (_'utf-8'_): Specify the encoding of the included file. - If not defined `'utf-8'` will be used. - ##### Examples ```jinja diff --git a/locale/es/README.md b/locale/es/README.md index c216fd8..0a88fa2 100644 --- a/locale/es/README.md +++ b/locale/es/README.md @@ -129,6 +129,8 @@ plugins: Este plugin provee dos directivas, una para incluir archivos Markdown y otra para incluir archivos de cualquier tipo. +#### Argumentos comunes + Las rutas de los archivos a incluir pueden ser: - URLs para incluir contenido remoto. @@ -148,38 +150,32 @@ Las cadenas **start** y **end** pueden contener caracteres usuales de secuencias de escape (al estilo Python) como `\n` para hacer coincidir contra caracteres de salto de línea. -#### **`include-markdown`** - -Incluye contenido de archivos Markdown, opcionalmente usando dos delimitadores -para filtrar el contenido a incluir. - -- # -**start**: Delimitador que marca el comienzo del contenido a incluir. -- # **end**: -Delimitador que marca el final del contenido a incluir. -- # -**preserve-includer-indent** (*true*): Cuando esta opción está habilitada (por -defecto), cada línea del contenido a incluir es indentada con el mismo número de -espacios usados para indentar la plantilla `{% %}` incluidora. Los valores -posibles son `true` y `false`. -- # -**dedent** (*false*): Si se habilita, el contenido incluido será dedentado. -- # -**exclude**: Expecifica mediante un glob los archivos que deben ser ignorados. -Sólo es útil pasando globs para incluir múltiples archivos. -- # **trailing-newlines** -(*true*): Cuando esta opción está deshabilitada, los saltos de línea finales que -se encuentran en el contenido a incluir se eliminan. Los valores posibles son -`true` y `false`. -- # -**recursive** (*true*): Cuando esta opción está deshabilitada, los archivos -incluidos no son procesados para incluir de forma recursiva. Los valores -posibles son `true` y `false`. -- # **order** -(*'alpha-path'*): Define el orden en el que múltiples archivos son incluidos -al usar globs. Los valores posibles son: +- # **start**: Delimitador que +marca el comienzo del contenido a incluir. +- # **end**: Delimitador que marca +el final del contenido a incluir. +- # **preserve-includer-indent** +(*true*): Cuando esta opción está habilitada (por defecto), cada línea del +contenido a incluir es indentada con el mismo número de espacios usados para +indentar la plantilla `{% %}` incluidora. Los valores posibles son `true` y +`false`. +- # **dedent** (*false*): Si +se habilita, el contenido incluido será dedentado. +- # **exclude**: Especifica +mediante un glob los archivos que deben ser ignorados. Sólo es útil pasando +globs para incluir múltiples archivos. +- # +**trailing-newlines** (*true*): Cuando esta opción está deshabilitada, los +saltos de línea finales que se encuentran en el contenido a incluir se eliminan. +Los valores posibles son `true` y `false`. +- # **recursive** +(*true*): Cuando esta opción está deshabilitada, los archivos incluidos no son +procesados para incluir de forma recursiva. Los valores posibles son `true` y +`false`. +- # **order** (*'alpha-path'*): +Define el orden en el que múltiples archivos son incluidos al usar globs. Los +posibles valores son: - Una combinación de un tipo de orden opcional y un sujeto de ordenación opcional separados por un guion (`-`), y opcionalmente precedidos por un guion (`-`) para indicar orden ascendente. Si no se especifica un tipo de orden o un sujeto @@ -206,9 +202,15 @@ cambio de metadatos en sistemas Unix). no especificar ningún orden y confiar en el orden por defecto del sistema de archivos. Esto puede ser diferente entre sistemas operativos, así que úsalo con precaución. -- # -**encoding** (*'utf-8'*): Especifica la codificación del archivo incluído. Si -no se define, se usará `'utf-8'`. +- # **encoding** +(*'utf-8'*): Especifica la codificación del archivo incluído. Si no se define, +se usará `'utf-8'`. + +#### **`include-markdown`** + +Incluye contenido de archivos Markdown, opcionalmente usando dos delimitadores +para filtrar el contenido a incluir. + - # **rewrite-relative-urls** (*true*): Cuando esta opción está habilitada (por defecto), los enlaces e @@ -285,62 +287,6 @@ especificado. Sólo soporta la sintaxis de encabezado de caracteres de hash Incluye el contenido de un archivo o un grupo de archivos. -- # **start**: Delimitador que -marca el comienzo del contenido a incluir. -- # **end**: Delimitador que marca -el final del contenido a incluir. -- # **preserve-includer-indent** -(*true*): Cuando esta opción está habilitada (por defecto), cada línea del -contenido a incluir es indentada con el mismo número de espacios usados para -indentar la plantilla `{% %}` incluidora. Los valores posibles son `true` y -`false`. -- # **dedent** (*false*): Si -se habilita, el contenido incluido será dedentado. -- # **exclude**: Especifica -mediante un glob los archivos que deben ser ignorados. Sólo es útil pasando -globs para incluir múltiples archivos. -- # -**trailing-newlines** (*true*): Cuando esta opción está deshabilitada, los -saltos de línea finales que se encuentran en el contenido a incluir se eliminan. -Los valores posibles son `true` y `false`. -- # **recursive** -(*true*): Cuando esta opción está deshabilitada, los archivos incluidos no son -procesados para incluir de forma recursiva. Los valores posibles son `true` y -`false`. -- # **order** (*'alpha-path'*): -Define el orden en el que múltiples archivos son incluidos al usar globs. Los -posibles valores son: - - Una combinación de un tipo de orden opcional y un sujeto de ordenación opcional -separados por un guion (`-`), y opcionalmente precedidos por un guion (`-`) -para indicar orden ascendente. Si no se especifica un tipo de orden o un sujeto -de ordenación, se usan los valores por defecto. Sigue la forma: -`[-]-` donde: - - **Tipo de orden**: - - `'alpha'` (por defecto): Orden alfabético. - - `'natural'`: Orden natural, de modo que por ejemplo `file2.md` va antes -`file10.md`. - - **Sujeto de ordenación**: - - `'path'` (por defecto): Ordena por la ruta completa del archivo. - - `'name'`: Ordena sólo por el nombre del archivo. - - `'extension'`: Ordena por la extensión del archivo. - - Una combinación de un guion opcional al principio para denotar orden ascendente -y uno de los siguientes valores en la forma `[-]` donde `` es -uno de los siguientes: - - `'size'`: Ordena por el tamaño del archivo. - - `'mtime'`: Ordena por la hora de modificación del archivo. - - `'ctime'`: Ordena por la hora de creación del archivo (o la última hora de -cambio de metadatos en sistemas Unix). - - `'atime'`: Ordena por la última hora de acceso al archivo. - - `'random'`: Orden aleatorio. - - `'system'`: Orden proporcionado por el sistema operativo. Esto es lo mismo que -no especificar ningún orden y confiar en el orden por defecto del sistema de -archivos. Esto puede ser diferente entre sistemas operativos, así que úsalo con -precaución. -- # **encoding** -(*'utf-8'*): Especifica la codificación del archivo incluído. Si no se define, -se usará `'utf-8'`. - ##### Ejemplos ```jinja diff --git a/locale/es/README.md.po b/locale/es/README.md.po index 1168523..c1a3b1f 100644 --- a/locale/es/README.md.po +++ b/locale/es/README.md.po @@ -86,41 +86,6 @@ msgstr "" "[fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-" "plugin/blob/master/locale/fr/README.md" -msgid "" -"# " -"**start**: Delimiter that marks the beginning of the content to include." -msgstr "" -"# " -"**start**: Delimitador que marca el comienzo del contenido a incluir." - -msgid "" -"# " -"**end**: Delimiter that marks the end of the content to include." -msgstr "" -"# " -"**end**: Delimitador que marca el final del contenido a incluir." - -msgid "" -"# **preserve-includer-indent** " -"(*true*): When this option is enabled (default), every line of the content " -"to include is indented with the same number of spaces used to indent the " -"includer `{% %}` template. Possible values are `true` and `false`." -msgstr "" -"# **preserve-includer-indent** " -"(*true*): Cuando esta opción está habilitada (por defecto), cada línea del " -"contenido a incluir es indentada con el mismo número de espacios usados para" -" indentar la plantilla `{% %}` incluidora. Los valores posibles son `true` y" -" `false`." - -msgid "" -"# " -"**dedent** (*false*): If enabled, the included content will be dedented." -msgstr "" -"# " -"**dedent** (*false*): Si se habilita, el contenido incluido será dedentado." - msgid "" "# **rewrite-relative-urls** (*true*): " @@ -161,16 +126,6 @@ msgstr "" " Sólo soporta la sintaxis de encabezado de caracteres de hash (`#`). Acepta " "valores negativos para eliminar caracteres `#` a la izquierda." -msgid "" -"# **exclude**: Specify with a glob which files should" -" be ignored. Only useful when passing globs to include multiple files." -msgstr "" -"# **exclude**: Expecifica mediante un glob los " -"archivos que deben ser ignorados. Sólo es útil pasando globs para incluir " -"múltiples archivos." - msgid "" "# **start**: Delimiter" " that marks the beginning of the content to include." @@ -214,18 +169,6 @@ msgstr "" "Especifica mediante un glob los archivos que deben ser ignorados. Sólo es " "útil pasando globs para incluir múltiples archivos." -msgid "" -"# **trailing-newlines** (*true*): When this" -" option is disabled, the trailing newlines found in the content to include " -"are stripped. Possible values are `true` and `false`." -msgstr "" -"# **trailing-newlines** (*true*): Cuando " -"esta opción está deshabilitada, los saltos de línea finales que se " -"encuentran en el contenido a incluir se eliminan. Los valores posibles son " -"`true` y `false`." - msgid "" "# **trailing-newlines** (*true*): When this option is " @@ -254,15 +197,6 @@ msgstr "" "envolver con comillas dobles `\"` o simples `'`, que se pueden escapar " "anteponiendo un carácter `\\` como `\\\"` y `\\'`." -msgid "" -"# **encoding** (*'utf-8'*): Specify the encoding of " -"the included file. If not defined `'utf-8'` will be used." -msgstr "" -"# **encoding** (*'utf-8'*): Especifica la " -"codificación del archivo incluído. Si no se define, se usará `'utf-8'`." - msgid "" "# **encoding** " "(*'utf-8'*): Specify the encoding of the included file. If not defined " @@ -407,17 +341,6 @@ msgstr "" "incluidos no son procesados para incluir de forma recursiva. Los valores " "posibles son `true` y `false`." -msgid "" -"# **recursive** (*true*): When this option is " -"disabled, included files are not processed for recursive includes. Possible " -"values are `true` and `false`." -msgstr "" -"# **recursive** (*true*): Cuando esta opción está " -"deshabilitada, los archivos incluidos no son procesados para incluir de " -"forma recursiva. Los valores posibles son `true` y `false`." - msgid "[Joe Rickerby]: https://github.com/joerick" msgstr "[Joe Rickerby]: https://github.com/joerick" @@ -472,15 +395,6 @@ msgstr "" "Se agregará un archivo *.gitignore* al directorio de caché si no existe para" " evitar confirmar los archivos de caché." -msgid "" -"# " -"**order** (*'alpha-path'*): Define the order in which multiple files are " -"included when using globs. Possible values are:" -msgstr "" -"# " -"**order** (*'alpha-path'*): Define el orden en el que múltiples archivos son" -" incluidos al usar globs. Los valores posibles son:" - msgid "**Order type**:" msgstr "**Tipo de orden**:" @@ -563,3 +477,6 @@ msgstr "" "guion (`-`) para indicar orden ascendente. Si no se especifica un tipo de " "orden o un sujeto de ordenación, se usan los valores por defecto. Sigue la " "forma: `[-]-` donde:" + +msgid "Common arguments" +msgstr "Argumentos comunes" diff --git a/locale/fr/README.md b/locale/fr/README.md index 534ff49..7116b6a 100644 --- a/locale/fr/README.md +++ b/locale/fr/README.md @@ -130,6 +130,8 @@ plugins: Ce plugin fournit deux directives, une pour inclure des fichiers Markdown et une autre pour inclure des fichiers de tout type. +#### Arguments communs + Les chemins des fichiers inclus peuvent être soit: - URL pour inclure du contenu distant. @@ -149,38 +151,31 @@ Les chaînes **start** et **end** peuvent contenir des séquences d'échappement habituelles (de style Python) telles que `\n` pour correspondre aux nouvelles lignes. -#### **`include-markdown`** - -Inclut contenu des Markdown fichiers, en utilisant éventuellement deux -délimiteurs pour filtrer le contenu à inclure. - -- # -**start**: Délimiteur qui marque le début du contenu à inclure. -- # **end**: -Délimiteur qui marque la fin du contenu à inclure. -- # -**preserve-includer-indent** (*true*): Lorsque cette option est activée (par -défaut), chaque ligne du contenu à inclure est indentée avec le même nombre -d'espaces utilisé pour indenter l'incluseur modèle `{% %}`. Les valeurs -possibles sont `true` et `false`. -- # -**dedent** (*false*): Lorsque est activée, le contenu inclus sera déchiqueté. -- # -**exclude**: Spécifiez avec un glob quels fichiers doivent être ignorés. -Uniquement utile lors du passage de globs pour inclure plusieurs fichiers. -- # **trailing-newlines** -(*true*): Lorsque cette option est désactivée, les nouvelles lignes de fin -trouvées dans le contenu à inclure sont supprimées. Les valeurs possibles sont -`true` et `false`. -- # -**recursive** (*true*): Lorsque cette option est désactivée, les fichiers -inclus ne sont pas traités pour des inclusions récursives. Les valeurs possibles -sont `true` et `false`. -- # **order** -(*'alpha-path'*): Définit l'ordre dans lequel plusieurs fichiers sont inclus -lors de l'utilisation de globs. Les possibles valeurs sont: +- # **start**: Délimiteur qui +marque le début du contenu à inclure. +- # **end**: Délimiteur qui marque +la fin du contenu à inclure. +- # **preserve-includer-indent** +(*true*): Lorsque cette option est activée (par défaut), chaque ligne du contenu +à inclure est indentée avec le même nombre d'espaces utilisé pour indenter +l'incluseur modèle `{% %}`. Les valeurs possibles sont `true` et `false`. +- # **dedent** (*false*): +Lorsque est activée, le contenu inclus sera déchiqueté. +- # **exclude**: Spécifiez +avec un glob quels fichiers doivent être ignorés. Uniquement utile lors du +passage de globs pour inclure plusieurs fichiers. +- # +**trailing-newlines** (*true*): Lorsque cette option est désactivée, les +nouvelles lignes de fin trouvées dans le contenu à inclure sont supprimées. Les +valeurs possibles sont `true` et `false`. +- # **recursive** +(*true*): Lorsque cette option est désactivée, les fichiers inclus ne sont pas +traités pour des inclusions récursives. Les valeurs possibles sont `true` et +`false`. +- # **order** (*'alpha-path'*): +Définit l'ordre dans lequel plusieurs fichiers sont inclus lors de +l'utilisation de globs. Les possibles valeurs sont: - Une combinaison d'un type de commande optionnel et d'un sujet de commande optionnel séparés par un trait d'union (`-`), et éventuellement précédés par un trait d'union (`-`) pour indiquer l'ordre ascendant. Si un type d'ordre ou un @@ -207,9 +202,15 @@ changement de métadonnées sur les systèmes Unix). de ne spécifier aucun ordre et de se fier à l'ordre par défaut du système de fichiers. Cela peut être différent entre les systèmes d'exploitation, alors utilisez-le avec précaution. -- # -**encoding** (*'utf-8'*): Spécifiez l'encodage du fichier inclus. S'il n'est -pas défini, `'utf-8'` sera utilisé. +- # **encoding** +(*'utf-8'*): Spécifiez l'encodage du fichier inclus. S'il n'est pas défini, +`'utf-8'` sera utilisé. + +#### **`include-markdown`** + +Inclut contenu des Markdown fichiers, en utilisant éventuellement deux +délimiteurs pour filtrer le contenu à inclure. + - # **rewrite-relative-urls** (*true*): Lorsque cette option est activée (par défaut), liens et images @@ -286,61 +287,6 @@ négatives pour supprimer les caractères `#` de tête. Inclus le contenu d'un fichier ou d'un groupe de fichiers. -- # **start**: Délimiteur qui -marque le début du contenu à inclure. -- # **end**: Délimiteur qui marque -la fin du contenu à inclure. -- # **preserve-includer-indent** -(*true*): Lorsque cette option est activée (par défaut), chaque ligne du contenu -à inclure est indentée avec le même nombre d'espaces utilisé pour indenter -l'incluseur modèle `{% %}`. Les valeurs possibles sont `true` et `false`. -- # **dedent** (*false*): -Lorsque est activée, le contenu inclus sera déchiqueté. -- # **exclude**: Spécifiez -avec un glob quels fichiers doivent être ignorés. Uniquement utile lors du -passage de globs pour inclure plusieurs fichiers. -- # -**trailing-newlines** (*true*): Lorsque cette option est désactivée, les -nouvelles lignes de fin trouvées dans le contenu à inclure sont supprimées. Les -valeurs possibles sont `true` et `false`. -- # **recursive** -(*true*): Lorsque cette option est désactivée, les fichiers inclus ne sont pas -traités pour des inclusions récursives. Les valeurs possibles sont `true` et -`false`. -- # **order** (*'alpha-path'*): -Définit l'ordre dans lequel plusieurs fichiers sont inclus lors de -l'utilisation de globs. Les possibles valeurs sont: - - Une combinaison d'un type de commande optionnel et d'un sujet de commande -optionnel séparés par un trait d'union (`-`), et éventuellement précédés par -un trait d'union (`-`) pour indiquer l'ordre ascendant. Si un type d'ordre ou un -sujet d'ordre n'est pas spécifié, les valeurs par défaut sont utilisées. Il suit -la forme: `[-]-` où: - - **Type d'ordre**: - - `'alpha'` (par défaut): Ordre alphabétique. - - `'natural'`: Ordre naturel, de sorte que par exemple `file2.md` vient avant -`file10.md`. - - **Sujet de l'ordre**: - - `'path'` (par défaut): Ordre par chemin de fichier complet. - - `'name'`: Ordre par nom de fichier uniquement. - - `'extension'`: Ordre par extension de fichier. - - Une combinaison d'un trait d'union préfixe optionnel pour indiquer l'ordre -ascendant et l'une des valeurs suivantes sous la forme `[-]` où -`` est l'une de: - - `'size'`: Ordre par taille de fichier. - - `'mtime'`: Ordre par heure de modification du fichier. - - `'ctime'`: Ordre par heure de création du fichier (ou la dernière heure de -changement de métadonnées sur les systèmes Unix). - - `'atime'`: Ordre par dernière heure d'accès au fichier. - - `'random'`: Ordre aléatoire. - - `'system'`: Ordre fourni par le système d'exploitation. C'est la même chose que -de ne spécifier aucun ordre et de se fier à l'ordre par défaut du système de -fichiers. Cela peut être différent entre les systèmes d'exploitation, alors -utilisez-le avec précaution. -- # **encoding** -(*'utf-8'*): Spécifiez l'encodage du fichier inclus. S'il n'est pas défini, -`'utf-8'` sera utilisé. - ##### Exemples ```jinja diff --git a/locale/fr/README.md.po b/locale/fr/README.md.po index 27a73f7..25cabcf 100644 --- a/locale/fr/README.md.po +++ b/locale/fr/README.md.po @@ -86,34 +86,6 @@ msgstr "" "[fr-readme-link]: https://github.com/mondeja/mkdocs-include-markdown-" "plugin/blob/master/locale/fr/README.md" -msgid "" -"# " -"**start**: Delimiter that marks the beginning of the content to include." -msgstr "" -"# " -"**start**: Délimiteur qui marque le début du contenu à inclure." - -msgid "" -"# " -"**end**: Delimiter that marks the end of the content to include." -msgstr "" -"# " -"**end**: Délimiteur qui marque la fin du contenu à inclure." - -msgid "" -"# **preserve-includer-indent** " -"(*true*): When this option is enabled (default), every line of the content " -"to include is indented with the same number of spaces used to indent the " -"includer `{% %}` template. Possible values are `true` and `false`." -msgstr "" -"# **preserve-includer-indent** " -"(*true*): Lorsque cette option est activée (par défaut), chaque ligne du " -"contenu à inclure est indentée avec le même nombre d'espaces utilisé pour " -"indenter l'incluseur modèle `{% %}`. Les valeurs possibles sont `true` et " -"`false`." - msgid "" "# **rewrite-relative-urls** (*true*): " @@ -154,24 +126,6 @@ msgstr "" "syntaxe d'en-tête du signe dièse (`#`). Cet argument accepte les valeurs " "négatives pour supprimer les caractères `#` de tête." -msgid "" -"# **exclude**: Specify with a glob which files should" -" be ignored. Only useful when passing globs to include multiple files." -msgstr "" -"# **exclude**: Spécifiez avec un glob quels fichiers " -"doivent être ignorés. Uniquement utile lors du passage de globs pour inclure" -" plusieurs fichiers." - -msgid "" -"# " -"**dedent** (*false*): If enabled, the included content will be dedented." -msgstr "" -"# " -"**dedent** (*false*): Lorsque est activée, le contenu inclus sera " -"déchiqueté." - msgid "" "# **start**: Delimiter" " that marks the beginning of the content to include." @@ -215,18 +169,6 @@ msgstr "" "Spécifiez avec un glob quels fichiers doivent être ignorés. Uniquement utile" " lors du passage de globs pour inclure plusieurs fichiers." -msgid "" -"# **trailing-newlines** (*true*): When this" -" option is disabled, the trailing newlines found in the content to include " -"are stripped. Possible values are `true` and `false`." -msgstr "" -"# **trailing-newlines** (*true*): Lorsque " -"cette option est désactivée, les nouvelles lignes de fin trouvées dans le " -"contenu à inclure sont supprimées. Les valeurs possibles sont `true` et " -"`false`." - msgid "" "# **trailing-newlines** (*true*): When this option is " @@ -255,15 +197,6 @@ msgstr "" "peuvent être entourés de guillemets doubles `\"` ou simples `'`, qui peuvent" " être échappés en leur ajoutant un caractère `\\` comme `\\\"` et `\\'`." -msgid "" -"# **encoding** (*'utf-8'*): Specify the encoding of " -"the included file. If not defined `'utf-8'` will be used." -msgstr "" -"# **encoding** (*'utf-8'*): Spécifiez l'encodage du " -"fichier inclus. S'il n'est pas défini, `'utf-8'` sera utilisé." - msgid "" "# **encoding** " "(*'utf-8'*): Specify the encoding of the included file. If not defined " @@ -406,17 +339,6 @@ msgstr "" "inclus ne sont pas traités pour des inclusions récursives. Les valeurs " "possibles sont `true` et `false`." -msgid "" -"# **recursive** (*true*): When this option is " -"disabled, included files are not processed for recursive includes. Possible " -"values are `true` and `false`." -msgstr "" -"# **recursive** (*true*): Lorsque cette option est " -"désactivée, les fichiers inclus ne sont pas traités pour des inclusions " -"récursives. Les valeurs possibles sont `true` et `false`." - msgid "[Joe Rickerby]: https://github.com/joerick" msgstr "[Joe Rickerby]: https://github.com/joerick" @@ -471,15 +393,6 @@ msgstr "" "Un fichier *.gitignore* sera ajouté au répertoire de cache s'il n'existe pas" " pour éviter de valider les fichiers de cache." -msgid "" -"# " -"**order** (*'alpha-path'*): Define the order in which multiple files are " -"included when using globs. Possible values are:" -msgstr "" -"# " -"**order** (*'alpha-path'*): Définit l'ordre dans lequel plusieurs fichiers " -"sont inclus lors de l'utilisation de globs. Les possibles valeurs sont:" - msgid "**Order type**:" msgstr "**Type d'ordre**:" @@ -562,3 +475,6 @@ msgstr "" " un trait d'union (`-`) pour indiquer l'ordre ascendant. Si un type d'ordre " "ou un sujet d'ordre n'est pas spécifié, les valeurs par défaut sont " "utilisées. Il suit la forme: `[-]-` où:" + +msgid "Common arguments" +msgstr "Arguments communs"