Skip to content

Commit 4d4aab4

Browse files
[DOCS] Add list of inventories with descriptions (#498)
Previously I could look into the settings.cfg to see keys and names of interlink inventories (because I do not know them all by heart), but now this is only available in the render-guides repository. There seems to be a twig directive to get the enum values and their links, but I acutally need more: * The name of the inventory as rendered for the Title * The actual URL used * The key of the inventory So I made a manual list of this because I didn't want to enhance the ENUM to do too many things. At least I need such a list, up to you if we want to maintain this in the docs this way, or if we would need a dynamic way...?!
1 parent 1073ee2 commit 4d4aab4

File tree

2 files changed

+131
-0
lines changed

2 files changed

+131
-0
lines changed

Documentation/Developer/InterlinkInventories.rst

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,135 @@ This would output:
3333
* :ref:`TYPO3 Explained 12 LTS <t3coreapi/v12:start>`
3434
* :ref:`TYPO3 Explained 12.4 <t3coreapi/12.4:start>`
3535

36+
.. _available-default-inventories:
37+
38+
Available default inventories
39+
-----------------------------
40+
41+
These inventories can be used by default in any rendered documentation:
42+
43+
44+
* Title: :doc:`changelog:Index`
45+
46+
Inventory key: :doc:`changelog <changelog:Index>`
47+
48+
URL: https://docs.typo3.org/c/typo3/cms-core/main/en-us/
49+
50+
* Title: :doc:`t3coreapi:Index`
51+
52+
Inventory key: :doc:`t3coreapi <t3coreapi:Index>`
53+
54+
URL: https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/
55+
56+
* Title: :doc:`t3tca:Index`
57+
58+
Inventory key: :doc:`t3tca <t3tca:Index>`
59+
60+
URL: https://docs.typo3.org/m/typo3/reference-tca/main/en-us/
61+
62+
* Title: :doc:`t3tsconfig:Index`
63+
64+
Inventory key: :doc:`t3tsconfig <t3tsconfig:Index>`
65+
66+
URL: https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/
67+
68+
* Title: :doc:`t3tsref:Index`
69+
70+
Inventory key: :doc:`t3tsref <t3tsref:Index>`
71+
72+
URL: https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/
73+
74+
* Title: :doc:`t3viewhelper:Index`
75+
76+
Inventory key: :doc:`t3viewhelper <t3viewhelper:Index>`
77+
78+
URL: https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/
79+
80+
* Title: :doc:`t3editors:Index`
81+
82+
Inventory key: :doc:`t3editors <t3editors:Index>`
83+
84+
URL: https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/
85+
86+
* Title: :doc:`t3install:Index`
87+
88+
Inventory key: :doc:`t3install <t3install:Index>`
89+
90+
URL: https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
91+
92+
* Title: :doc:`t3upgrade:Index`
93+
94+
Inventory key: :doc:`t3upgrade <t3upgrade:Index>`
95+
96+
URL: https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
97+
98+
* Title: :doc:`t3sitepackage:Index`
99+
100+
Inventory key: :doc:`t3sitepackage <t3sitepackage:Index>`
101+
102+
URL: https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/
103+
104+
* Title: :doc:`t3start:Index`
105+
106+
Inventory key: :doc:`t3start <t3start:Index>`
107+
108+
URL: https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/
109+
110+
* Title: :doc:`t3translate:Index`
111+
112+
Inventory key: :doc:`t3translate <t3translate:Index>`
113+
114+
URL: https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
115+
116+
* Title: :doc:`t3ts45:Index`
117+
118+
Inventory key: :doc:`t3ts45 <t3ts45:Index>`
119+
120+
URL: https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/
121+
122+
* Title: :doc:`h2document:Index`
123+
124+
Inventory key: :doc:`h2document <h2document:Index>`
125+
126+
URL: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/
127+
128+
* Title: :doc:`t3content:Index`
129+
130+
Inventory key: :doc:`t3content <t3content:Index>`
131+
132+
URL: https://docs.typo3.org/m/typo3/guide-contentandmarketing/main/en-us/
133+
134+
* Title: :doc:`t3contribute:Index`
135+
136+
Inventory key: :doc:`t3contribute <t3contribute:Index>`
137+
138+
URL: https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/
139+
140+
* Title: :doc:`t3writing:Index`
141+
142+
Inventory key: :doc:`t3writing <t3writing:Index>`
143+
144+
URL: https://docs.typo3.org/m/typo3/writing-guide/main/en-us/
145+
146+
* Title: :doc:`fluid:Index`
147+
148+
Inventory key: :doc:`fluid <fluid:Index>`
149+
150+
URL: https://docs.typo3.org/other/typo3fluid/fluid/main/en-us/
151+
152+
* Title: :doc:`t3renderguides:Index`
153+
154+
Inventory key: :doc:`t3renderguides <t3renderguides:Index>`
155+
156+
URL: https://docs.typo3.org/other/t3docs/render-guides/main/en-us/
157+
158+
* Title: :doc:`t3exceptions:Index`
159+
160+
Inventory key: :doc:`t3exceptions <t3exceptions:Index>`
161+
162+
URL: https://docs.typo3.org/typo3cms/exceptions/main/en-us/
163+
164+
36165
.. _typo3-version:
37166

38167
Setting the preferred TYPO3 version

packages/typo3-version-handling/src/DefaultInventories.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
enum DefaultInventories: string
66
{
7+
// IMPORTANT: If new default inventories are added, please
8+
// also add them to `Documentation/Developer/InterlinkInventories.rst`.
79
case changelog = 'changelog';
810
case t3coreapi = 't3coreapi';
911
case t3tca = 't3tca';

0 commit comments

Comments
 (0)