Module:Path/doc: Difference between revisions
Appearance
Content deleted Content added
mNo edit summary |
mNo edit summary |
||
Line 4: | Line 4: | ||
== Functions == |
== Functions == |
||
In all functions the {{para|1}} argument can indifferently be a relative (i.e. beginning with <code>./</code> or <code>../</code>) or an absolute path. |
{{A note}} In all functions the {{para|1}} argument can indifferently be a relative (i.e. beginning with <code>./</code> or <code>../</code>) or an absolute path. |
||
=== <code>abs</code> === |
=== <code>abs</code> === |
||
The <code>abs</code> function parses the {{para|1}} argument and returns it as an absolute path. |
|||
==== Examples ==== |
==== Examples ==== |
||
Line 20: | Line 20: | ||
=== <code>rel</code> === |
=== <code>rel</code> === |
||
The <code>rel</code> function parses the {{para|1}} argument and returns it as a relative path. |
|||
==== Examples ==== |
==== Examples ==== |
||
Line 36: | Line 36: | ||
=== <code>sub</code> === |
=== <code>sub</code> === |
||
The <code>sub</code> function parses the {{para|1}} argument and returns it as a partial path with only the subpages shown. |
|||
==== Examples ==== |
==== Examples ==== |
Revision as of 01:50, 6 September 2024
This module offers utilities to convert paths into different formats.
Functions
Note: In all functions the
|1=
argument can indifferently be a relative (i.e. beginning with ./
or ../
) or an absolute path.
abs
The abs
function parses the |1=
argument and returns it as an absolute path.
Examples
{{#invoke:path|abs|./example}}
- ↳ Module:Path/doc/example
{{#invoke:path|abs|.}}
- ↳ Module:Path/doc
{{#invoke:path|abs|Wikipedia:Lua}}
- ↳ Wikipedia:Lua
{{#invoke:path|abs}}
- ↳ Module:Path/doc
rel
The rel
function parses the |1=
argument and returns it as a relative path.
Examples
{{#invoke:path|rel|Module:Path/example}}
- ↳ ../example
{{#invoke:path|rel|Module:Path}}
- ↳ ..
{{#invoke:path|rel|Wikipedia:Lua}}
- ↳ Wikipedia:Lua
{{#invoke:path|rel}}
- ↳ .
[[Module:Path/example|{{#invoke:path|rel|Module:Path/example}}]]
- ↳ ../example
- See also {{Relative link}}
- ↳ ../example
sub
The sub
function parses the |1=
argument and returns it as a partial path with only the subpages shown.
Examples
{{#invoke:path|sub|Module:Path/example}}
- ↳ example
{{#invoke:path|sub|Module:Path}}
- ↳
{{#invoke:path|sub|Wikipedia:Lua}}
- ↳ Wikipedia:Lua
{{#invoke:path|sub}}
- ↳
[[Module:Path/example|{{#invoke:path|sub|Module:Path/example}}]]
- ↳ example
- See also {{Relative link implicit}}
- ↳ example