Registered User mNo edit summary |
Registered User mNo edit summary Tag: 2017 source edit |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
Usage: <nowiki>{{</nowiki>DocSource | domain={{HighlightParam|<domain>}} | path={{HighlightParam|<path>}} | text={{HighlightParam|<link text>}} | version={{HighlightParam|<version>}}}} | Usage: <nowiki>{{</nowiki>DocSource | domain={{HighlightParam|<domain>}} | path={{HighlightParam|<path>}} | text={{HighlightParam|<link text>}} | version={{HighlightParam|<version>}}}} | ||
Where: | |||
* {{HighlightParam|<domain>}} is the '''mandatory''' string that identifies the domain of the document. The possible values are: | * {{HighlightParam|<domain>}} is the '''mandatory''' string that identifies the domain of the document. The possible values are: | ||
** '''Linux kernel''': the document belongs to the Linux kernel domain. | ** '''Linux kernel''': the document belongs to the Linux kernel domain. | ||
| Line 23: | Line 24: | ||
* {{HighlightParam|<link text>}} is an '''optional''' link text (text that is displayed instead of the URL). | * {{HighlightParam|<link text>}} is an '''optional''' link text (text that is displayed instead of the URL). | ||
{{ReviewsComments|-- [[User:Jean Christophe Trotin|Jean Christophe Trotin]] ([[User talk:Jean Christophe Trotin|talk]]) 16:05, 3 October 2022 (CEST)<br />FYI, for AWS, the latest version is the v1 (i.e., writing latest or v1 in the URL leads to the same page), while there is also a v2 version}} | {{ReviewsComments|-- [[User:Jean Christophe Trotin|Jean Christophe Trotin]] ([[User talk:Jean Christophe Trotin|talk]]) 16:05, 3 October 2022 (CEST)<br />FYI, for AWS, the latest version is the v1 (i.e., writing latest or v1 in the URL leads to the same page), while there is also a v2 version}} | ||
* {{HighlightParam|<version>}} is an '''optional''' version number (branch or tag) if the default one doesn't fit. Per default, the URL points to: | * {{HighlightParam|<version>}} is an '''optional''' version number (branch or tag) if the default one doesn't fit. Per default, the URL points to: | ||
** the ''' | ** the '''6.1''' version branch of the Linux kernel | ||
** the '''4. | ** the '''4.2.4''' version branch of the Yocto Project | ||
** the '''latest''' version branch of the AWS IoT Greengrass | ** the '''latest''' version branch of the AWS IoT Greengrass | ||
** the ''' | ** the '''2022.10''' version branch of the U-Boot documentation | ||
** the '''2. | ** the '''2.8''' version branch of the TF-A documentation | ||
** the '''3. | ** the '''3.19.0''' version branch of the OP-TEE documentation | ||
==Basic examples== | ==Basic examples== | ||
| Line 86: | Line 84: | ||
2- {{DocSource | domain=TF-A | path=getting_started/index.html}} | 2- {{DocSource | domain=TF-A | path=getting_started/index.html}} | ||
|- | |- | ||
| '''OP- | | '''OP-TEE''' | ||
<pre style="white-space: pre-wrap;"> | <pre style="white-space: pre-wrap;"> | ||
1- {{DocSource | domain=OP-TEE | path=general/index.html}}<br /> | 1- {{DocSource | domain=OP-TEE | path=general/index.html}}<br /> | ||
| Line 202: | Line 200: | ||
'''Linux kernel''': | '''Linux kernel''': | ||
<nowiki> | <nowiki> | ||
[https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}| | [https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v6.1}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | ||
</nowiki> | </nowiki> | ||
'''Yocto Project''': | '''Yocto Project''': | ||
<nowiki> | <nowiki> | ||
[https://docs.yoctoproject.org/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|4. | [https://docs.yoctoproject.org/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|4.2.1}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | ||
</nowiki> | </nowiki> | ||
| Line 217: | Line 215: | ||
'''U-Boot''': | '''U-Boot''': | ||
<nowiki> | <nowiki> | ||
[https://u-boot.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}| | [https://u-boot.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2022.10}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | ||
</nowiki> | </nowiki> | ||
'''TF-A''': | '''TF-A''': | ||
<nowiki> | <nowiki> | ||
[https://trustedfirmware-a.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2. | [https://trustedfirmware-a.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2.8}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | ||
</nowiki> | </nowiki> | ||
'''OP- | '''OP-TEE''': | ||
<nowiki> | <nowiki> | ||
[https://optee.readthedocs.io/en/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|3.19.0}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| ({{#replace:{{{version|}}}| |}})}}] | |||
</nowiki> | </nowiki> | ||
</noinclude>{{#switch: {{{domain}}} | </noinclude>{{#switch: {{{domain}}} | ||
| Linux kernel = [https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v6.1}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | |||
| Yocto Project = [https://docs.yoctoproject.org/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|4.2.4}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | |||
| AWS Greengrass = [https://docs.aws.amazon.com/greengrass/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|latest}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | |||
| U-Boot= [https://u-boot.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2022.10}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | |||
| TF-A = [https://trustedfirmware-a.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2. | | TF-A = [https://trustedfirmware-a.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2.8}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}] | ||
| OP-TEE |OP-TEE_OS = [https://optee.readthedocs.io/en/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|3. | | OP-TEE |OP-TEE_OS = [https://optee.readthedocs.io/en/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|3.19.0}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| ({{#replace:{{{version|}}}| |}})}}] | ||
| {{Highlight| Unsupported domain!}} | |||
}} | }} | ||
Latest revision as of 18:31, 24 June 2024
1. Usage[edit source]
The DocSource template is used to indicate the URL of any Linux® kernel, Yocto Project, AWS IoT Greengrass, U-Boot, TF-A, and OP-TEE document used in this wiki.
Usage: {{DocSource | domain=<domain> | path=<path> | text=<link text> | version=<version>}}
Where:
- <domain> is the mandatory string that identifies the domain of the document. The possible values are:
- Linux kernel: the document belongs to the Linux kernel domain.
- Yocto Project: the document belongs to the Yocto Project domain.
- AWS Greengrass: the document belongs to the AWS IoT Greengrass domain.
- U-Boot: the document belongs to U-Boot domain
- TF-A: the document belongs to TF-A domain.
- OP-TEE: the document belongs to OP-TEE domain.
- <path> is the mandatory relative path of the document from the root URL of the domain. The root URLs are:
- https://www.kernel.org/doc/html/ for the Linux kernel domain
- https://docs.yoctoproject.org/ for the Yocto Project domain
- https://docs.aws.amazon.com/greengrass/ for the AWS IoT Greengrass domain
- https://u-boot.readthedocs.io for the U-Boot domain
- https://trustedfirmware-a.readthedocs.io for the TF-A domain
- https://optee.readthedocs.io for the OP-TEE domain
- <link text> is an optional link text (text that is displayed instead of the URL).
- <version> is an optional version number (branch or tag) if the default one doesn't fit. Per default, the URL points to:
- the 6.1 version branch of the Linux kernel
- the 4.2.4 version branch of the Yocto Project
- the latest version branch of the AWS IoT Greengrass
- the 2022.10 version branch of the U-Boot documentation
- the 2.8 version branch of the TF-A documentation
- the 3.19.0 version branch of the OP-TEE documentation
2. Basic examples[edit source]
| You type | You get |
|---|---|
Linux kernel
1- {{DocSource | domain=Linux kernel | path=crypto/index.html}}<br /> 2- {{DocSource | domain=Linux kernel | path=gpu/drm-uapi.html}} |
|
Yocto Project
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br /> 2- {{DocSource | domain=Yocto Project | path=brief-yoctoprojectqs}} |
|
AWS IoT Greengrass
1- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html}}<br />
2- {{DocSource | domain=AWS Greengrass | path=developerguide/device-config-setup.html}}
|
1- developerguide/what-is-gg.html |
U-Boot
1- {{DocSource | domain=U-Boot | path=index.html}}<br /> 2- {{DocSource | domain=U-Boot | path=build/index.html}} |
1- index.html |
TF-A
1- {{DocSource | domain=TF-A | path=index.html}}<br /> 2- {{DocSource | domain=TF-A | path=getting_started/index.html}} |
|
OP-TEE
1- {{DocSource | domain=OP-TEE | path=general/index.html}}<br /> 2- {{DocSource | domain=OP-TEE| path=index.html}} |
1- general/index.html |
3. More examples[edit source]
| You type | You get |
|---|---|
Linux kernel
1- {{DocSource | domain=Linux kernel | path=crypto/index.html}}<br /> 2- {{DocSource | domain=Linux kernel | path=crypto/index.html | text=Linux Kernel Crypto API}}<br /> 3- {{DocSource | domain=Linux kernel | path=crypto/index.html | version=4.19}}<br /> 4- {{DocSource | domain=Linux kernel | path=crypto/index.html | text=Linux Kernel Crypto API | version=4.19}} |
1- crypto/index.html |
Yocto Project
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br /> 2- {{DocSource | domain=Yocto Project | path=overview-manual | text=Yocto Project Overview and Concepts Manual}}<br /> 3- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html | version=3.0}}<br /> 4- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html | text=Yocto Project Overview and Concepts Manual | version=3.0}} |
1- overview-manual |
AWS IoT Greengrass
1- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html}}<br /> 2- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html | text=What is AWS IoT Greengrass?}}<br /> 3- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html | version=2}}<br /> 4- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html | text=What is AWS IoT Greengrass? | version=2}} |
1- developerguide/what-is-gg.html |
U-Boot
1- {{DocSource | domain=U-Boot | path=build/index.html}}<br /> 2- {{DocSource | domain=U-Boot | path=build/index.html | text=How to build U-Boot?}}<br /> 3- {{DocSource | domain=U-Boot | path=build/index.html | version=2021.01}}<br /> 4- {{DocSource | domain=U-Boot | path=build/index.html | text=How to build U-Boot? | version=2021.01}} |
1- build/index.html |
TF-A
1- {{DocSource | domain=TF-A| path=getting_started/docs-build.html}}<br /> 2- {{DocSource | domain=TF-A| path=getting_started/docs-build.html| text=Building Documentation}}<br /> 3- {{DocSource | domain=TF-A| path=getting_started/docs-build.html| version=2.5}}<br /> 4- {{DocSource | domain=TF-A| path=getting_started/docs-build.html| text=Building Documentation| version=2.5}} |
1- getting_started/docs-build.html |
OP-TEE
1- {{DocSource | domain=OP-TEE| path=architecture/index.html}}<br /> 2- {{DocSource | domain=OP-TEE| path=architecture/index.html | text=Architecture}}<br /> 3- {{DocSource | domain=OP-TEE| path=architecture/index.html| version=3.14.0}}<br /> 4- {{DocSource | domain=OP-TEE| path=architecture/index.html | text=Architecture | version=3.14.0}} |
1- architecture/index.html |
Check that there's no space before and after the text
1- BEFORE{{DocSource | domain=Linux kernel | path=crypto/index.html}}AFTER<br /> 2- BEFORE{{DocSource | domain=Linux kernel | path=crypto/index.html | text=Linux Kernel Crypto API}}AFTER<br /> 3- BEFORE{{DocSource | domain=Linux kernel | path=crypto/index.html | version=4.19}}AFTER<br /> 4- BEFORE{{DocSource | domain=Linux kernel | path=crypto/index.html | text=Linux Kernel Crypto API | version=4.19}}AFTER |
1- BEFOREcrypto/index.htmlAFTER |
Unsupported domain
{{DocSource | domain=Unsupported domain | path=Document}}
|
Unsupported domain! |
4. Code[edit source]
Linux kernel: [https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v6.1}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]
Yocto Project: [https://docs.yoctoproject.org/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|4.2.1}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]
AWS IoT Greengrass [https://docs.aws.amazon.com/greengrass/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|latest}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]
U-Boot: [https://u-boot.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2022.10}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]
TF-A: [https://trustedfirmware-a.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2.8}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| (v{{#replace:{{{version|}}}| |}})}}]
OP-TEE: [https://optee.readthedocs.io/en/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|3.19.0}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}| ({{#replace:{{{version|}}}| |}})}}]
Unsupported domain!