Difference between revisions of "Template:Path"

Revision as of 08:57, 28 November 2020

Documentation for the above template (sometimes hidden from view).

Description

Template primarily intended for {{Game data}} but can also be used with {{File}}, {{Folder}}, and {{Registry}}.

See the editing guide for real-world paths and examples.

Syntax

{{Path|localappdata}} or {{P|localappdata}} produces ]]

|localappdata = %LOCALAPPDATA%
|public = %PUBLIC%
|allusersprofile
|programdata = %PROGRAMDATA%
|programfiles = %PROGRAMFILES%
|windir = %WINDIR%
|syswow64 = SysWOW64
|osxhome = $HOME
|linuxhome = $HOME
|xdgdatahome = $XDG_DATA_HOME
|xdgconfighome = $XDG_CONFIG_HOME
|#default =

}}

Arguments

General

Argument	Result	Location
`game`	<path-to-game>]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| The base installation folder
`uid`	<user-id>]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| The user ID or profile name (specific to your account or computer). Typically used to refer to Steam/Ubisoft Connect/game-specific user ID or profile name.
`steam`	<Steam-folder>]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| The base Steam installation folder
`ubisoftconnect`	<Ubisoft-Connect-folder>]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| The base Ubisoft Connect (Ubisoft Game Launcher) installation folder

Windows registry

Argument	Result	Location
`hkcu`	HKEY_CURRENT_USER]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| HKEY_CURRENT_USER registry path
`hklm`	HKEY_LOCAL_MACHINE]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| HKEY_LOCAL_MACHINE registry path
`wow64`	Wow6432Node]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| Used for 32-bit applications running on 64-bit operating systems

Windows filesystem

Argument	Result	Location
`username`	%USERNAME%]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| Not a location, but resolves to the username in Windows
`userprofile`	%USERPROFILE%]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| Base user profile folder
`userprofile\documents`	%USERPROFILE%\Documents]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| "Documents" folder
`appdata`	%APPDATA%]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| AppData\Roaming
`localappdata`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| AppData\Local
`userprofile\appdata\locallow`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| AppData\LocalLow
`public`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| Public (aka shared) user profile folder
`allusersprofile` or `programdata`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| Program data folder
`programfiles`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| Shared applications folder. Use `game` instead (`<path-to-game>]]`	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }}).
`windir`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| Windows directory
`syswow64`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| Stores 32-bit system libraries on 64-bit operating systems

OS X

Argument	Result	Location
`osxhome`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| User home folder ~/

Linux

Argument	Result	Location
`linuxhome`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| User home folder ~/
`xdgdatahome`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| ~/.local/share/
`xdgconfighome`	]]	localappdata = %LOCALAPPDATA%	public = %PUBLIC%	allusersprofile	programdata = %PROGRAMDATA%	programfiles = %PROGRAMFILES%	windir = %WINDIR%	syswow64 = SysWOW64	osxhome = $HOME	linuxhome = $HOME	xdgdatahome = $XDG_DATA_HOME	xdgconfighome = $XDG_CONFIG_HOME	#default = }} \|\| ~/.config/

Redirects

{{P}}

Related

{{LocalizedPath}}

Visit Template:Path/Documentation to edit this text. (How does this work?)

@@ Line 17: / Line 17: @@
   |userprofile\documents = [[Glossary:Game data#User profile|{{Abbr|%USERPROFILE%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]\{{Abbr|Documents|replace with My Documents for Windows XP or Wine/Proton|template=yes}}
   |appdata = [[Glossary:Game data#User application data|{{Abbr|%APPDATA%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]
+ |userprofile\locallow = [[Glossary:Game data#User application data|{{Abbr|%USERPROFILE%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]\LocalLow|template=yes}}]]
   |localappdata = [[Glossary:Game data#User application data|{{Abbr|%LOCALAPPDATA%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]
   |public = [[Glossary:Game data#Shared profile|{{Abbr|%PUBLIC%|Windows: copy this path into a folder address bar to go to this location|template=yes}}]]