View source for Module:Path/doc

{{Module rating|beta}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
This module offers utilities to convert paths into different formats.

== Functions ==
{{A note}} In all functions the {{para|1}} argument can indifferently be a relative (i.e. beginning with <code>./</code> or <code>../</code> or <code>/</code>) or an absolute path.

{{vpad}}

=== <code>abs</code> ===
The <code>abs</code> function parses the {{para|1}} argument and returns it as an absolute path.

==== Examples ====
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|abs|./example}}</syntaxhighlight>
*: ↳ {{#invoke:path|abs|./example}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|abs|.}}</syntaxhighlight>
*: ↳ {{#invoke:path|abs|.}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|abs|Wikipedia:Lua}}</syntaxhighlight>
*: ↳ {{#invoke:path|abs|Wikipedia:Lua}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|abs}}</syntaxhighlight>
*: ↳ {{#invoke:path|abs}}

{{vpad|1.5em}}

=== <code>rel</code> ===
The <code>rel</code> function parses the {{para|1}} argument and returns it as a relative path.

==== Examples ====
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|rel|Module:Path/example}}</syntaxhighlight>
*: ↳ {{#invoke:path|rel|Module:Path/example}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|rel|Module:Path}}</syntaxhighlight>
*: ↳ {{#invoke:path|rel|Module:Path}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|rel|Wikipedia:Lua}}</syntaxhighlight>
*: ↳ {{#invoke:path|rel|Wikipedia:Lua}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|rel}}</syntaxhighlight>
*: ↳ {{#invoke:path|rel}}
* <syntaxhighlight lang="wikitext" inline>[[Module:Path/example|{{#invoke:path|rel|Module:Path/example}}]]</syntaxhighlight>
*: ↳ [[Module:Path/example|{{#invoke:path|rel|Module:Path/example}}]]
*:* See also {{tl|Relative link}}

{{vpad|1.5em}}

=== <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 ====
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|sub|Module:Path/example}}</syntaxhighlight>
*: ↳ {{#invoke:path|sub|Module:Path/example}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|sub|Module:Path}}</syntaxhighlight>
*: ↳ {{#invoke:path|sub|Module:Path}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|sub|Wikipedia:Lua}}</syntaxhighlight>
*: ↳ {{#invoke:path|sub|Wikipedia:Lua}}
* <syntaxhighlight lang="wikitext" inline>{{#invoke:path|sub}}</syntaxhighlight>
*: ↳ {{#invoke:path|sub}}
* <syntaxhighlight lang="wikitext" inline>[[Module:Path/example|{{#invoke:path|sub|Module:Path/example}}]]</syntaxhighlight>
*: ↳ [[Module:Path/example|{{#invoke:path|sub|Module:Path/example}}]]
*:* See also {{tl|Relative link implicit}}

{{vpad}}

== See also ==
* {{Tl|Relative link}}
* {{Tl|Relative link implicit}}
* [[:Category:Wikipedia utility modules]]

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Wikipedia utility modules|{{PAGENAME}}]]
}}</includeonly>

<noinclude>
[[Category:Module documentation pages]]
</noinclude>