Skip to content

Commit

Permalink
feat: New option value "none" for option linking.paths.
Browse files Browse the repository at this point in the history
  • Loading branch information
about-code committed Sep 3, 2021
1 parent 78ee6e7 commit a0fc951
Show file tree
Hide file tree
Showing 6 changed files with 72 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
## headingIdAlgorithm Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :--------- | :---------- |
| `"github"` | |
| `"md5"` | |
1 change: 1 addition & 0 deletions conf/v5/doc/schema-defs-linking-properties-paths.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
| :----------- | :---------- |
| `"relative"` | |
| `"absolute"` | |
| `"none"` | |
20 changes: 20 additions & 0 deletions conf/v5/doc/schema-defs-linking.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Control how paths to linked documents will be constructed. Choosing "absolute" r
| :----------- | :---------- |
| `"relative"` | |
| `"absolute"` | |
| `"none"` | |

## mentions

Expand Down Expand Up @@ -64,6 +65,25 @@ An array of numerical values each in a range of 1-6 denoting the depths of headi

* Type: `integer[]`

## headingIdAlgorithm

Algorithm to use for generating heading IDs. The 'github' algorithm (default) may only guarantee uniqueness per file. Use a cryptographic algorithm to have IDs be unique across all output files. The latter may be required when concatenating output files with tools like pandoc ( <https://pandoc.org> ).

`headingIdAlgorithm`

* is optional

* Type: unknown

### headingIdAlgorithm Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :--------- | :---------- |
| `"github"` | |
| `"md5"` | |

## limitByAlternatives

This option can be used to limit the number of links, if there are multiple definitions of a term. When using a positive value, then the system creates links *no more than ...* alternative links. If the number is negative then the absolute amount indicates to *not link a term at all once there are at least ...* alternative definitions. For example:
Expand Down
21 changes: 21 additions & 0 deletions conf/v5/doc/schema-properties-linking.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ The default value is:
5,
6
],
"headingIdAlgorithm": "github",
"limitByAlternatives": 10
}
```
Expand Down Expand Up @@ -54,6 +55,7 @@ Control how paths to linked documents will be constructed. Choosing "absolute" r
| :----------- | :---------- |
| `"relative"` | |
| `"absolute"` | |
| `"none"` | |

## mentions

Expand Down Expand Up @@ -84,6 +86,25 @@ An array of numerical values each in a range of 1-6 denoting the depths of headi

* Type: `integer[]`

## headingIdAlgorithm

Algorithm to use for generating heading IDs. The 'github' algorithm (default) may only guarantee uniqueness per file. Use a cryptographic algorithm to have IDs be unique across all output files. The latter may be required when concatenating output files with tools like pandoc ( <https://pandoc.org> ).

`headingIdAlgorithm`

* is optional

* Type: unknown

### headingIdAlgorithm Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :--------- | :---------- |
| `"github"` | |
| `"md5"` | |

## limitByAlternatives

This option can be used to limit the number of links, if there are multiple definitions of a term. When using a positive value, then the system creates links *no more than ...* alternative links. If the number is negative then the absolute amount indicates to *not link a term at all once there are at least ...* alternative definitions. For example:
Expand Down
21 changes: 21 additions & 0 deletions conf/v5/doc/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ The default value is:
5,
6
],
"headingIdAlgorithm": "github",
"limitByAlternatives": 10
}
```
Expand Down Expand Up @@ -714,6 +715,7 @@ Control how paths to linked documents will be constructed. Choosing "absolute" r
| :----------- | :---------- |
| `"relative"` | |
| `"absolute"` | |
| `"none"` | |

### mentions

Expand Down Expand Up @@ -744,6 +746,25 @@ An array of numerical values each in a range of 1-6 denoting the depths of headi

* Type: `integer[]`

### headingIdAlgorithm

Algorithm to use for generating heading IDs. The 'github' algorithm (default) may only guarantee uniqueness per file. Use a cryptographic algorithm to have IDs be unique across all output files. The latter may be required when concatenating output files with tools like pandoc ( <https://pandoc.org> ).

`headingIdAlgorithm`

* is optional

* Type: unknown

#### headingIdAlgorithm Constraints

**enum**: the value of this property must be equal to one of the following values:

| Value | Explanation |
| :--------- | :---------- |
| `"github"` | |
| `"md5"` | |

### limitByAlternatives

This option can be used to limit the number of links, if there are multiple definitions of a term. When using a positive value, then the system creates links *no more than ...* alternative links. If the number is negative then the absolute amount indicates to *not link a term at all once there are at least ...* alternative definitions. For example:
Expand Down
2 changes: 1 addition & 1 deletion conf/v5/schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@
,"paths": {
"description": "Control how paths to linked documents will be constructed. Choosing \"absolute\" requires a \"baseUrl\" as well."
,"type": "string"
,"enum": ["relative", "absolute"]
,"enum": ["relative", "absolute", "none"]
}
,"mentions": {
"description": "Control the link density and whether every occurrence of a term in your documents should be linked with its glossary definition or only the first occurrence within a particular range."
Expand Down

0 comments on commit a0fc951

Please sign in to comment.