@paroicms/site-generator-plugin 0.5.2 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -14,7 +14,7 @@ Make sure web pages are distinct from each other by:
|
|
|
14
14
|
|
|
15
15
|
Guidelines:
|
|
16
16
|
|
|
17
|
-
- NEVER repeat
|
|
17
|
+
- NEVER repeat the same title among several sub-contents.
|
|
18
18
|
- Never invite the user to write a comment. There is no comment system.
|
|
19
19
|
|
|
20
20
|
Each web page is composed by several sub-contents. Use the following exact format:
|
|
@@ -55,11 +55,10 @@ Guidelines for creating the hierarchical bullet list:
|
|
|
55
55
|
- Write `"list of"`, and then the **type name** within backquotes.
|
|
56
56
|
- Append `(parts)`.
|
|
57
57
|
- Add a coma, then write: `"list name:"` and append an identifier for the list name.
|
|
58
|
-
-
|
|
59
|
-
- Reusing the same node type several times (for recursivity etc.):
|
|
60
|
-
- When the same node type is reused as a child in several places, then write its children only on the first occurence.
|
|
58
|
+
- Avoid recursivity. But if you can't avoid reusing a node type, then write its children only on the first occurence.
|
|
61
59
|
- On this task, do not focus on fields. If the website description provide fields then you will report them in the unused information. In particular, a collection of medias (a carousel, a slider, an image gallery, a slideshow, etc.) is a type of field.
|
|
62
60
|
- Don't try to provide a comment mechanism when the user requests a blog. Blog comments do not belong to the hierarchy of node types.
|
|
61
|
+
- NEVER ever reuse the same type name for 2 distinct node type. Pay particular attention to words spelled identically in the singular and plural. Each distinct node type must have a unique name through the whole tree structure.
|
|
63
62
|
|
|
64
63
|
Here's an example of a correct output:
|
|
65
64
|
|
|
@@ -83,27 +82,18 @@ Here is another incorrect example:
|
|
|
83
82
|
|
|
84
83
|
<incorrect_example>
|
|
85
84
|
* `home` (routing document)
|
|
86
|
-
* `
|
|
87
|
-
* `
|
|
88
|
-
* list of `page` (regular documents)
|
|
89
|
-
* `vegetals`
|
|
90
|
-
* `pages` (regular document)
|
|
91
|
-
* list of `page` (regular documents)
|
|
85
|
+
* `species` (routing document)
|
|
86
|
+
* list of `species` (regular documents)
|
|
92
87
|
</incorrect_example>
|
|
93
88
|
|
|
94
|
-
This incorrect example fails because the
|
|
89
|
+
This incorrect example fails because the type name `species` is used for 2 different types. You can distinguish them by suffixing both the collection and the item types:
|
|
95
90
|
|
|
96
91
|
<correct_example>
|
|
97
92
|
* `home` (routing document)
|
|
98
|
-
* `
|
|
99
|
-
* `
|
|
100
|
-
* list of `page` (regular documents)
|
|
101
|
-
* `vegetals`
|
|
102
|
-
* `pages` (regular document)
|
|
93
|
+
* `speciesColl` (routing document)
|
|
94
|
+
* list of `speciesItem` (regular documents)
|
|
103
95
|
</correct_example>
|
|
104
96
|
|
|
105
|
-
Notice: the `pages` node will have the same child types for both usage. But we describe them only the first time it appears on the tree.
|
|
106
|
-
|
|
107
97
|
Here's an example of correct output using parts, and with the default contact and search pages:
|
|
108
98
|
|
|
109
99
|
<correct_example>
|
|
@@ -126,6 +116,7 @@ Guidelines for creating the dictionnary YAML:
|
|
|
126
116
|
|
|
127
117
|
- Use a YAML syntax: pay attention to the indentation.
|
|
128
118
|
- Keys: each key is the name of a node type or the name of a list of parts.
|
|
119
|
+
- If the same type is reused several times, then write only one entry in this dictionnary.
|
|
129
120
|
- Values contains the properties. For a node type, provide the following properties:
|
|
130
121
|
- confidence: Your confidence level for the accuracy of this node type (0.0-1.0).
|
|
131
122
|
- kind: Can be `routingDocument`, `regularDocument`, `part`.
|