Template:Rl/doc: Difference between revisions

From UCSB Nanofab Wiki
Jump to navigation Jump to search
m (arguments heading)
No edit summary
Line 1: Line 1:
The Recipe Link "rl" template is used on the Tables of recipes, such as the [[Dry_Etching_Recipes|Dry Etching Recipes page]]. We use this to show that a recipe is available for some material, and also link to the page/section with that recipe.
The Recipe Link "rl" template is used on the Tables of recipes, such as the [[Dry_Etching_Recipes|Dry Etching Recipes page]]. We use this to show that a recipe is available for some material, and also link to the page/section with that recipe.


It will display the text "R" and allows you to link to a subheading on a page (eg. one of the links in the table of contents on a page). The resulting URL will jump to that position on the web page.
It will display as a default, if no recipe level is indicated, the text "R" and allows you to link to a subheading on a page (eg. one of the links in the table of contents on a page). The resulting URL will jump to that position on the web page.

If you want to display a different Recipe maturity level, you can specify this using the third argument of the function as indicated below.


=== Arguments ===
=== Arguments ===


This template (rl = Recipe Link) takes 2 arguments.
This template (rl = Recipe Link) takes 3 arguments.


*the first argument is the name of the main page.
*the first argument is the name of the main page.
*the second argument is the subheading that you want to link to.
*the second argument is the subheading that you want to link to.
*the third argument is the recipe maturity level. R1 through R6, as defined by the recipe maturity table definitions


=== Example ===
=== Example ===


To link to the section "''Al Etch (Panasonic 1)''" on the ''[[ICP_Etching_Recipes | ICP Etching Recipes]]'' page, you would write the template like so:
To declare a recipe maturity level of R2 and link to the section "''Al Etch (Panasonic 1)''" on the ''[[ICP_Etching_Recipes | ICP Etching Recipes]]'' page, you would write the template like so:


<pre>
<pre>
{{rl|ICP Etching Recipes|Al Etch (Panasonic 1)}}
{{rl|ICP Etching Recipes|Al Etch (Panasonic 1)|R2}}
</pre>
</pre>


This will display as so:
This will display as so:


{{rl|ICP Etching Recipes|Al Etch (Panasonic 1)}}
{{rl|ICP Etching Recipes|Al Etch (Panasonic 1)|R2}}

Revision as of 00:58, 15 August 2024

The Recipe Link "rl" template is used on the Tables of recipes, such as the Dry Etching Recipes page. We use this to show that a recipe is available for some material, and also link to the page/section with that recipe.

It will display as a default, if no recipe level is indicated, the text "R" and allows you to link to a subheading on a page (eg. one of the links in the table of contents on a page). The resulting URL will jump to that position on the web page.

If you want to display a different Recipe maturity level, you can specify this using the third argument of the function as indicated below.

Arguments

This template (rl = Recipe Link) takes 3 arguments.

  • the first argument is the name of the main page.
  • the second argument is the subheading that you want to link to.
  • the third argument is the recipe maturity level. R1 through R6, as defined by the recipe maturity table definitions

Example

To declare a recipe maturity level of R2 and link to the section "Al Etch (Panasonic 1)" on the ICP Etching Recipes page, you would write the template like so:

{{rl|ICP Etching Recipes|Al Etch (Panasonic 1)|R2}}

This will display as so:

R2