Skip to content

Commit 77d6430

Browse files
committed
Added note about product_url being deprecated.
1 parent c7356f1 commit 77d6430

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

docs/TEMPLATE-STYLE.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ This is the brand name or manufacturer of the product. It must match one of the
3030
in the [vendors.xml](../templates/vendors.xml) file. Add a new vendor line if it does not
3131
currently exist.
3232

33+
3334
### *part* Attribute
3435

3536
This is the actual part number of the product. This is usually a short set of numbers and/or
@@ -47,6 +48,7 @@ is acceptable. For example:
4748
- `3274.1`, `3274.2`, and `3274.3`
4849
- `5931-Disc`, and `5931-Spine`
4950

51+
5052
### *_description* Attribute
5153

5254
- Descriptions should be short. They should describe what the product is in very simple terms
@@ -58,7 +60,7 @@ is acceptable. For example:
5860
- If at all possible, try to reuse descriptions from other templates (this keeps the
5961
number of unique strings that need translation to a minimum).
6062

61-
- Don't repeat the brand or part number.
63+
- Don't repeat the brand or part number in the description.
6264

6365
- Only capitalize the first word of the description.
6466

@@ -76,10 +78,19 @@ The following are good bad descriptions:
7678
| `Dymo continuous labels` || Don't include brand or part number. |
7779

7880

79-
*Meta* Nodes
80-
------------
81+
82+
*Meta* Node Attributes
83+
----------------------
84+
85+
### *category* Attribute
8186

8287
- All templates should include all appropriate `<Meta category=...` nodes.
8388
- Categories must match one of the existing categories in the [categories.xml](../templates/categories.xml) file. Do not add new categories!
8489
- All templates should include either a `<Meta category="label"/>` or `<Meta category="card"/>` node.
8590

91+
92+
### *product_url* Attribute
93+
94+
Unfortunately, manufacturer websites are constantly being updated and rearranged, rendering such deep URLs obsolete very quickly. Therefore,
95+
use of this attribute is deprecated.
96+

0 commit comments

Comments
 (0)