View source for Template:rl/doc

This is one of templates used to make links.

===Absolute links===
====Normal font====
{{tl params|lt|path,title?}} - creates a link to a page using absolute path. The default title is only the last part of the path.
: Example: {{tt|1={{lt{{!}}cpp/language/statements}}}} results in the link: {{lt|cpp/language/statements}}.
: Example: {{tt|1={{lt{{!}}cpp/language/statements|Labeled statements}}}} results in the link: {{lt|cpp/language/statements|Labeled statements}}.
: Note: the previous example is just another way to create the same link using the standard template
: {{tt|[}}{{tt|1=[cpp/language/statements{{!}}Labeled statements}}{{tt|1=]]}}, which also results in [[cpp/language/statements|Labeled statements]].

{{tl params|ls|2=path#section}} - makes a link to a ''section'' (anchor) on a page given by absolute ''path''. The ''section'' text is also used as the title. To create a link on the same page the ''path'' part should be empty.
: Example: {{tt|1={{ls{{!}}cpp/language/lambda#Syntax}}}} results in the link: {{ls|cpp/language/lambda#Syntax}}.
: To create a link to a section/anchor within the current page the ''path'' part should be omitted.
: Example: {{tt|1={{ls{{!}}#Relative links}}}} results in the link: {{ls|#Relative links}} (i.e. a link to the section in this page).

{{tl params|lsd|path#Section}} ("lsd" stands for "Link to Section De-capitalized") - almost the same as {{tl|ls}} except it de-capitalizes the first letter of displayed section name. To create a link on the same page the ''path'' part should be empty.
: Example: {{tt|1={{lsd{{!}}cpp/language/array#Arrays of unknown bound}}}} results in the link: {{lsd|cpp/language/array#Arrays of unknown bound}}.
: Example: {{tt|1={{lsd{{!}}#Relative links}}}} results in the link: {{lsd|#Relative links}} (i.e. a link to the section in this page).

====Teletype font====
{{tl params|ltt|path,title?}} - creates a link to a page using absolute path. The default title is only the last part of the path.
: Example: {{tt|1={{ltt{{!}}cpp/language/switch}}}} results in the link: {{ltt|cpp/language/switch}}.
: Example: {{tt|1={{ltt{{!}}cpp/language/switch|switch(expr)}}}} results in the link: {{ltt|cpp/language/switch|switch(expr)}}.

{{tl params|ltf|2=path,title?,args=arguments?}} - creates a link to a page using absolute path. The default title is only the last part of the path. Parentheses indicating ''function'' are appended, which enclose the optional ''arguments''.
: Example: {{tt|1={{ltf{{!}}cpp/error/terminate}}}} results in the link: {{ltf|cpp/error/terminate}}.
: Example: {{tt|1={{ltf{{!}}cpp/error/terminate|std::terminate}}}} results in the link: {{ltf|cpp/error/terminate|std::terminate}}.
: Example: {{tt|1={{ltf{{!}}cpp/error/set_terminate|std::set_terminate|args=nullptr}}}} results in the link: {{ltf|cpp/error/set_terminate|std::set_terminate|args=nullptr}}.

{{tl params|ltp|2=path,title?,targs=template arguments?}} - creates a link to a page using absolute path. The default title is only the last part of the path. Angle brackets indicating ''template'' are appended, which enclose the optional ''template arguments''.
: Example: {{tt|1={{ltp{{!}}cpp/container/vector}}}} results in the link: {{ltp|cpp/container/vector}}.
: Example: {{tt|1={{ltp{{!}}cpp/container/vector|targs=int}}}} results in the link: {{ltp|cpp/container/vector|targs=int}}.
: Example: {{tt|1={{ltp{{!}}cpp/container/vector|targs=std::size_t}}}} results in the link: {{ltp|cpp/container/vector|targs=std::size_t}}.

{{tl params|ltpf|2=path,title?,targs=template arguments?,args=arguments?}} - creates a link to a page using absolute path. The default title is only the last part of the path. Angle brackets indicating ''template'' are appended, which enclose the optional ''template arguments''. After that, parentheses indicating ''function'' are appended, which enclose the optional ''arguments''.
: Example: {{tt|1={{ltpf{{!}}cpp/container/vector/vector|targs=int|args=5}}}} results in the link: {{ltpf|cpp/container/vector/vector|targs=int|args=5}}.
: Example: {{tt|1={{ltpf{{!}}cpp/locale/use_facet|targs=Facet|args=loc}}}} results in the link: {{ltpf|cpp/locale/use_facet|targs=Facet|args=loc}}.

{{tl params|lst|2=path#section}} - makes a link to a ''section'' (anchor) on a page given by absolute ''path''. The ''section'' text is also used as the title. To create a link on the same page the ''path'' part should be empty.
: Example: {{tt|1={{lst{{!}}cpp/ranges#maybe-const}}}} results in the link: {{lst|cpp/ranges#maybe-const}}.
: Example: {{tt|1={{lst{{!}}#top}}}} results in the link: {{lst|#top}}.
: Example: {{tt|1={{lst{{!}}#top_}}}} results in the link: {{lst|#top_}} {{small|(note that the trailing underscore character of the link is automatically trimmed)}}.

{{tl params|l2tt|page,title1?,title2?}} - creates a link to a page using absolute path. The title is formed from the two last parts of the path with {{ttb|::}} be inserted between them. Each of these parts can be overridden by ''title1'' and ''title2''.
: Example: {{tt|1={{l2tt{{!}}cpp/container/vector/size}}}} results in the link: {{l2tt|cpp/container/vector/size}}.
: Example: {{tt|1={{l2tt{{!}}cpp/container/vector/size|size() const}}}} results in the link: {{l2tt|cpp/container/vector/size|size() const}}.
: Example: {{tt|1={{l2tt{{!}}cpp/container/vector/size|size()|std::vector<T>}}}} results in the link: {{l2tt|cpp/container/vector/size|size()|std::vector<T>}}.

{{tl params|l2tf|2=page,title1?,title2?,args=arguments?,suffix=suffix?}} - creates a link to a page using absolute path. The title is formed from the two last parts of the path with {{ttb|::}} be inserted between them. Each of these parts can be overridden by ''title1'' and ''title2''. Parentheses indicating ''function'' are appended, which enclose the optional ''arguments'' and are followed by the optional ''suffix''.
: Example: {{tt|1={{l2tf{{!}}cpp/container/vector/size}}}} results in the link: {{l2tf|cpp/container/vector/size}}.
: Example: {{tt|1={{l2tf{{!}}cpp/container/vector/size|suffix=const}}}} results in the link: {{l2tf|cpp/container/vector/size|suffix=const}}.
: Example: {{tt|1={{l2tf{{!}}cpp/container/vector/size|size|std::vector<T>}}}} results in the link: {{l2tf|cpp/container/vector/size|size|std::vector<T>}}.

====Italic teletype font====
{{tl params|lti|path,title?}} - creates a link to a page using absolute path. The default title is only the last part of the path.
: Example: {{tt|1={{lti{{!}}cpp/concepts/boolean-testable}}}} results in the link: {{lti|cpp/concepts/boolean-testable}}.

{{tl params|ltpi|2=path,title?,targs=template arguments?}} - creates a link to a page using absolute path. The default title is only the last part of the path. Angle brackets indicating ''template'' are appended, which enclose the optional ''template arguments''.
: Example: {{tt|1={{ltpi{{!}}cpp/concepts/boolean-testable}}}} results in the link: {{ltpi|cpp/concepts/boolean-testable}}.
: Example: {{tt|1={{ltpi{{!}}cpp/concepts/boolean-testable|targs=int}}}} results in the link: {{ltpi|cpp/concepts/boolean-testable|targs=int}}.

{{tl params|lsi|2=path#section}} - makes a link to a ''section'' (anchor) on a page given by absolute ''path''. The ''section'' text is also used as the title. To create a link on the same page the ''path'' part should be empty.
: Example: {{tt|1={{lsi{{!}}cpp/ranges#maybe-const}}}} results in the link: {{lsi|cpp/ranges#maybe-const}}.
: Example: {{tt|1={{lsi{{!}}#top}}}} results in the link: {{lsi|#top}}.
: Example: {{tt|1={{lsi{{!}}#top_}}}} results in the link: {{lsi|#top_}} {{small|(note that the trailing underscore character of the link is automatically trimmed)}}.

===Absolute links with prefix {{co|std::}}===
The following convenience templates generate links whose titles begin with {{tt|std::}}. They can be used in places where {{tl|lc}} fails to generate a link. All links appear in teletype font.

{{tl params|ltt std|path}} - link to a page using absolute path. The title is {{tt|std::}} followed by the last part of the path.
: Example: {{tt|1={{ltt std{{!}}cpp/container/mdspan}}}} results in the link: {{ltt std|cpp/container/mdspan}}.

{{tl params|ltf std|path}} - link to a page using absolute path. The title is {{tt|std::}} followed by the last part of the path and parentheses indicating ''function''.
: Example: {{tt|1={{ltf std{{!}}cpp/io/print}}}} results in the link: {{ltf std|cpp/io/print}}.

{{tl params|l2tt std|path}} - link to a page using absolute path. The title is {{tt|std::}} followed by the last two parts of the path joined by {{tt|::}}.
: Example: {{tt|1={{l2tt std{{!}}cpp/utility/basic_stacktrace/current}}}} results in the link: {{l2tt std|cpp/utility/basic_stacktrace/current}}.

{{tl params|l2tf std|path}} - link to a page using absolute path. The title is {{tt|std::}} followed by the last two parts of the path joined by {{tt|::}} and parentheses indicating ''function''.
: Example: {{tt|1={{l2tf std{{!}}cpp/utility/expected/value}}}} results in the link: {{l2tf std|cpp/utility/expected/value}}.

===Relative links===
====Normal font====
{{tl params|rl|page,title?}} - makes a link to a page relative to this page (i.e. to a sub-page).

{{tl params|rlp|page,title?}} - makes a link to a page relative to the parent page.

{{tl params|rlp|/,title}} - makes a link to the parent page.

{{tl params|rlps|page&#35;section}} - makes a link to a ''section'' (anchor) on a page relative to the parent page. The title of the generated link is the section name.

{{tl params|rlpsd|page&#35;Section}} - makes a link to a ''section'' (anchor) on a page relative to the parent page. The title of the generated link is the section name with the first letter de-capitalized.

====Teletype font====
{{tl params|rlt|page,title?}} - makes a link to a page relative to this page (i.e. to a sub-page).

{{tl params|rlpt|page,title?}} - makes a link to a page relative to the parent page.

{{tl params|rlpt|/,title}} - makes a link to the parent page.

{{tl params|rlpf|2=page,title?,args=arguments?}} - makes a link to a page relative to the parent page. Parentheses indicating ''function'' are appended, which enclose the optional ''arguments''.

{{tl params|rlpst|page&#35;section}} - makes a link to a ''section'' (anchor) on a page relative to the parent page. The title of the generated link is the section name.

{{tl params|ttt|identifier}} - makes a link to the current page (via the [[#top|#top]] link).
: Example: {{tl|ttt|this_page}} results in {{ttt|this_page}}.

====Italic teletype font====
{{tl params|rli|page,title?}} - makes a link to a page relative to this page (i.e. to a sub-page).

{{tl params|rlpi|page,title?}} - makes a link to a page relative to the parent page.

{{tl params|rlpi|/,title}} - makes a link to the parent page.

{{tl params|rlpsi|page&#35;section}} - makes a link to a ''section'' (anchor) on a page relative to the parent page. The title of the generated link is the section name.

===Decorated links===
{{tl params|attr|2=attribute,title?,additional title?,lang=language?}}

: Used to create a link to [[c/language/attributes|C]]/[[cpp/language/attributes|C++]] language attribute specifier description. Parameters:
* ''attribute'' - an attribute specifier name.
* ''title'' - an attribute specifier title.
* ''additional title'' - additional elements after the title.
* ''language'' - ''cpp'' or ''c''. If ''language'' is not given, {{tl|get lang}} is used.

: Example: {{tlc|attr|assume}} results in {{attr|assume}}.
: Example: {{tlc|attr|noreturn|_Noreturn|lang{{=}}c}} results in {{attr|noreturn|_Noreturn|lang=c}}.
: Example: {{tlc|attr|deprecated|3{{=}}("''because''")}} results in {{attr|deprecated|3=("''because''")}}.