Last edited 10 months ago

Template:DocSource: Difference between revisions

Registered User
mNo edit summary
Registered User
mNo edit summary
Tag: 2017 source edit
 
(34 intermediate revisions by 4 users not shown)
Line 2: Line 2:
{{UpdateNeededForNewRelease|Please update the versions (branches or tags): several times in this template}}
{{UpdateNeededForNewRelease|Please update the versions (branches or tags): several times in this template}}
==Usage==
==Usage==
The [[Template:DocSource|DocSource]] template is used '''to indicate the URL of any Linux<sup>&reg;</sup> kernel, Yocto Project, and AWS IoT Greengrass document''' used in this wiki.
The [[Template:DocSource|DocSource]] template is used '''to indicate the URL of any Linux<sup>&reg;</sup> kernel, Yocto Project, AWS IoT Greengrass, U-Boot, TF-A, and OP-TEE document''' used in this wiki.


  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:
 
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 11: Line 12:
** '''AWS Greengrass''': the document belongs to the AWS IoT Greengrass domain.
** '''AWS Greengrass''': the document belongs to the AWS IoT Greengrass domain.
** '''U-Boot''': the document belongs to U-Boot 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.


* {{HighlightParam|<path>}} is the '''mandatory''' relative path of the document from the root URL of the domain. The root URLs are:
* {{HighlightParam|<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://www.kernel.org/doc/html/''' for the Linux kernel domain
** '''https://www.yoctoproject.org/docs/''' for the Yocto Project domain
** '''https://docs.yoctoproject.org/''' for the Yocto Project domain
** '''https://docs.aws.amazon.com/greengrass/''' for the AWS IoT Greengrass domain
** '''https://docs.aws.amazon.com/greengrass/''' for the AWS IoT Greengrass domain
** '''https://u-boot.readthedocs.io/en''' for the U-Boot 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


{{ReviewsComments|-- Nathalie <br />For next release (v3.1?) you may need to switch on the new Yocto document site : https://docs.yoctoproject.org/, for v3.0 , seen with Romuald, we stay on v3.1.4 yocto doc }}
* {{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}}


* {{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 '''v5.10''' branch of the Linux kernel
** the '''6.1''' version branch of the Linux kernel
** the '''3.1.4''' branch of the Yocto Project
** the '''4.2.4''' version  branch of the Yocto Project  
** the '''latest''' branch of the AWS IoT Greengrass
** the '''latest''' version branch of the AWS IoT Greengrass
** the '''v2020.10''' branch of the U-Boot Documentation
** 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


==Basic examples==
==Basic examples==
Line 43: Line 50:
| '''Yocto Project'''
| '''Yocto Project'''
<pre style="white-space: pre-wrap;">
<pre style="white-space: pre-wrap;">
1- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html}}<br />
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br />
2- {{DocSource | domain=Yocto Project | path=brief-yoctoprojectqs/brief-yoctoprojectqs.html}}
2- {{DocSource | domain=Yocto Project | path=brief-yoctoprojectqs}}
</pre>
</pre>
|
|
1- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html}}<br />
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br />
2- {{DocSource | domain=Yocto Project | path=brief-yoctoprojectqs/brief-yoctoprojectqs.html}}
2- {{DocSource | domain=Yocto Project | path=brief-yoctoprojectqs}}
|-
|-
| '''AWS IoT Greengrass'''
| '''AWS IoT Greengrass'''
Line 67: Line 74:
1- {{DocSource | domain=U-Boot | path=index.html}}<br />
1- {{DocSource | domain=U-Boot | path=index.html}}<br />
2- {{DocSource | domain=U-Boot | path=build/index.html}}
2- {{DocSource | domain=U-Boot | path=build/index.html}}
|-
| '''TF-A'''
<pre style="white-space: pre-wrap;">
1- {{DocSource | domain=TF-A | path=index.html}}<br />
2- {{DocSource | domain=TF-A | path=getting_started/index.html}}
</pre>
|
1- {{DocSource | domain=TF-A | path=index.html}}<br />
2- {{DocSource | domain=TF-A | path=getting_started/index.html}}
|-
| '''OP-TEE'''
<pre style="white-space: pre-wrap;">
1- {{DocSource | domain=OP-TEE | path=general/index.html}}<br />
2- {{DocSource | domain=OP-TEE| path=index.html}}
</pre>
|
1- {{DocSource | domain=OP-TEE | path=general/index.html}}<br />
2- {{DocSource | domain=OP-TEE| path=index.html}}
|}
|}


Line 88: Line 113:
| '''Yocto Project'''
| '''Yocto Project'''
<pre style="white-space: pre-wrap;">
<pre style="white-space: pre-wrap;">
1- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html}}<br />
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br />
2- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html | text=Yocto Project Overview and Concepts 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 />
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}}
4- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html | text=Yocto Project Overview and Concepts Manual | version=3.0}}
</pre>
</pre>
|
|
1- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html}}<br />
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br />
2- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html | text=Yocto Project Overview and Concepts 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 />
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}}
4- {{DocSource | domain=Yocto Project | path=overview-manual/overview-manual.html | text=Yocto Project Overview and Concepts Manual | version=3.0}}
Line 103: Line 128:
1- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html}}<br />
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 />
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.0}}<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.0}}
4- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html | text=What is AWS IoT Greengrass? | version=2}}
</pre>
</pre>
|
|
1- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html}}<br />
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 />
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.0}}<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.0}}
4- {{DocSource | domain=AWS Greengrass | path=developerguide/what-is-gg.html | text=What is AWS IoT Greengrass? | version=2}}
|-
|-
| '''U-Boot'''
| '''U-Boot'''
Line 124: Line 149:
3- {{DocSource | domain=U-Boot | path=build/index.html | version=2021.01}}<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}}
4- {{DocSource | domain=U-Boot | path=build/index.html | text=How to build U-Boot? | version=2021.01}}
|-
| '''TF-A'''
<pre style="white-space: pre-wrap;">
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}}
</pre>
|
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}}
|-
| '''OP-TEE'''
<pre style="white-space: pre-wrap;">
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}}
</pre>
|
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}}
|-
|-
| Check that there's no space before and after the text
| Check that there's no space before and after the text
Line 149: Line 200:
'''Linux kernel''':
'''Linux kernel''':
<nowiki>
<nowiki>
[https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v5.10}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
[https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v6.1}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
</nowiki>
</nowiki>


'''Yocto Project''':
'''Yocto Project''':
<nowiki>
<nowiki>
[https://www.yoctoproject.org/docs/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|3.1.4}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
[https://docs.yoctoproject.org/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|4.2.1}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
</nowiki>
</nowiki>


'''AWS IoT Greengrass'''
'''AWS IoT Greengrass'''
<nowiki>
<nowiki>
[https://docs.aws.amazon.com/greengrass/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|latest}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;v({{#replace:{{{version|}}}| |}})}}]
[https://docs.aws.amazon.com/greengrass/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|latest}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
</nowiki>
</nowiki>


'''U-Boot''':
'''U-Boot''':
<nowiki>
<nowiki>
[https://u-boot.readthedocs.io/en/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|v2020.10}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
[https://u-boot.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2022.10}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
</nowiki>
 
'''TF-A''':
<nowiki>
[https://trustedfirmware-a.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2.8}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
</nowiki>
 
'''OP-TEE''':
<nowiki>
[https://optee.readthedocs.io/en/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|3.19.0}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;({{#replace:{{{version|}}}| |}})}}]
</nowiki>
</nowiki>


</noinclude>{{#switch: {{{domain}}}
</noinclude>{{#switch: {{{domain}}}
| Linux kernel = [https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v5.10}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
| Linux kernel = [https://www.kernel.org/doc/html/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v6.1}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
| Yocto Project = [https://www.yoctoproject.org/docs/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|3.1.4}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
| Yocto Project = [https://docs.yoctoproject.org/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|4.2.4}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
| AWS Greengrass = [https://docs.aws.amazon.com/greengrass/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|latest}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(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|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
| U-Boot= [https://u-boot.readthedocs.io/en/{{#if: {{{version|}}}|{{#replace:{{{version|}}}| |}}|v2020.10}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(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|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
  | {{Highlight| Unsupported domain!}}
| TF-A = [https://trustedfirmware-a.readthedocs.io/en/{{#if: {{{version|}}}|v{{#replace:{{{version|}}}| |}}|v2.8}}/{{#replace:{{{path|}}}| |}} {{#if: {{{text|}}}|{{{text}}}|{{{path}}}}}{{#if: {{{version|}}}|&nbsp;(v{{#replace:{{{version|}}}| |}})}}]
| 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|}}}|&nbsp;({{#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.
  • <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}}

1- crypto/index.html
2- gpu/drm-uapi.html

Yocto Project
1- {{DocSource | domain=Yocto Project | path=overview-manual}}<br />
2- {{DocSource | domain=Yocto Project | path=brief-yoctoprojectqs}}

1- overview-manual
2- 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
2- developerguide/device-config-setup.html

U-Boot
1- {{DocSource | domain=U-Boot | path=index.html}}<br />
2- {{DocSource | domain=U-Boot | path=build/index.html}}

1- index.html
2- build/index.html

TF-A
1- {{DocSource | domain=TF-A | path=index.html}}<br />
2- {{DocSource | domain=TF-A | path=getting_started/index.html}}

1- Unsupported domain!
2- Unsupported domain!

OP-TEE
1- {{DocSource | domain=OP-TEE | path=general/index.html}}<br />
2- {{DocSource | domain=OP-TEE| path=index.html}}

1- Unsupported domain!
2- Unsupported domain!

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
2- Linux Kernel Crypto API
3- crypto/index.html (v4.19)
4- Linux Kernel Crypto API (v4.19)

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
2- Yocto Project Overview and Concepts Manual
3- overview-manual/overview-manual.html (v3.0)
4- Yocto Project Overview and Concepts Manual (v3.0)

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
2- What is AWS IoT Greengrass?
3- developerguide/what-is-gg.html (v2)
4- What is AWS IoT Greengrass? (v2)

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
2- How to build U-Boot?
3- build/index.html (v2021.01)
4- How to build U-Boot? (v2021.01)

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- Unsupported domain!
2- Unsupported domain!
3- Unsupported domain!
4- Unsupported domain!

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- Unsupported domain!
2- Unsupported domain!
3- Unsupported domain!
4- Unsupported domain!

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
2- BEFORELinux Kernel Crypto APIAFTER
3- BEFOREcrypto/index.html (v4.19)AFTER
4- BEFORELinux Kernel Crypto API (v4.19)AFTER

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!

No categories assignedEdit