Favourites.xml - Revision history

Karellen: Updated for v20

2023-01-25T03:59:02Z

Updated for v20

← Older revision		Revision as of 03:59, 25 January 2023
Line 1:		Line 1:
	{{mininav\| [[Userdata]] {{l2\| [[Favourites]] }} }}		{{mininav\| [[Userdata]] {{l2\| [[Favourites]] }} }}

	<section begin="intro" />Developer documentation detailing the structure and modification of the favourites.xml file. For the User Guide about the favourites feature see '''''[[Favourites]]'''''.<section end="intro" />

	=~~= Favourites via xml=~~=		= Introduction =
	The '''~~display order~~''' ~~seen in the Favourites screen is determined by the order of the entries in the xml~~ file~~. Adjust~~ the ~~order~~ of ~~the favourites in the file~~ to ~~modify~~ the ~~displayed order in {{kodi}}~~.		The '''''favourites.xml''''' file contains the data of all items added to the '''[[Favourites]]''' listing.

	The '''''favourites.xml''''' is located in the '''''[[Userdata]]''''' folder.		For advanced users, the ''favourites.xml'' file can be edited manually, rather than using the {{kodi}} interface to create and edit the listing.

			See also: '''[[Favourites]]'''



			= Favourites.xml =
			The '''''favourites.xml''''' file is located in the '''''[[Userdata]]''''' folder.

			The '''User preference order''' of the Favourites screen is determined by the order of the entries in the xml file, which is the order they were added to the Favourites list.

			To change the order, simply move the entries to the desired order.


	'''Example: '''		'''Example: '''
	The format of the favourites.xml is as follows~~. The example shows Playlist, TV Show, TV Episode, Artist, Album and Add-on~~.		The format of the favourites.xml is as follows.
	<syntaxhighlight lang=xml enclose="div">		<syntaxhighlight lang=xml enclose="div">
	<favourites>		<favourites>
	<favourite name="~~Marvel Universe~~"~~>ActivateWindow(10025,"special~~://~~profile~~/~~playlists~~/~~video~~/~~Marvel Universe.xsp",return~~)</~~favourite>~~		<favourite name="The Big Bang Theory" thumb="smb://HTPC-PC/J/TV Complete AK/Big Bang Theory (2007)/poster.jpg">ActivateWindow(10025,"videodb://tvshows/titles/1/",return)</favourite>
	~~<favourite name="Continuum" thumb="E:\TV Show- TEST\Continuum\thumb~~.jpg">ActivateWindow(10025,"E:~~\\TV Show- TEST\\Continuum\\~~",return)</favourite>		<favourite name="Artwork Dump" thumb="C:\Kodi\KODI- v20 Release\portable_data\addons\script.artwork.dump\icon.png">RunAddon("script.artwork.dump")</favourite>
	<favourite name="~~1x02. Fast Times~~" thumb="E:\~~TV Show~~- ~~TEST~~\~~Continuum~~\~~Continuum S01E02-thumb~~.~~jpg~~">~~PlayMedia~~("~~E:\\TV Show- TEST\\Continuum\\Continuum S01E02~~.~~mkv~~")</favourite>		<favourite name="U2" thumb="C:\Kodi\Test- Music\U2\Best Of 1980-1990, The\discart.png">ActivateWindow(10502,"C:\\Kodi\\Test- Music\\U2\\",return)</favourite>
	<favourite name="~~Era~~" thumb="F:\Music\~~ArtistInfoKodi~~\~~Era~~\~~folder~~.~~jpg~~">ActivateWindow(10502,"~~musicdb~~:~~//artists/113/?albumartistsonly=false~~",return)</favourite>		<favourite name="Open Space" thumb="C:\Kodi\Test- Music\Open Space\discart.png">ActivateWindow(10502,"C:\\Kodi\\Test- Music\\Open Space\\",return)</favourite>
	<favourite name="~~NextPVR PVR Client~~" thumb="F:\Kodi ~~v18~~- ~~Nightly~~\~~addons~~\~~pvr.nextpvr\icon~~.png~~">RunAddon(pvr.nextpvr)</favourite>~~
	~~<favourite name="TV Show- TEST~~">ActivateWindow(~~10025~~,"E:\\~~TV Show- TEST\\",return)</favourite>~~
	~~<favourite name="Artist Albums">ActivateWindow(10502,"F:~~\\Music\\~~FLAC\\Artist Albums~~\\",return)</favourite>
	</favourites>		</favourites>
	</syntaxhighlight >		</syntaxhighlight >

			'''Note:''' When adding library items to Favourites, some items are linked by their ID's contained in the library databases. If these items are deleted and rescraped or refreshed, the ID's will most likely change and the favourites entry becomes invalid.



	=~~=Renaming a favourite via xml==~~		= Format of Favourite Item =
	~~Change the name~~ of ~~any item by amending the ''<fabourite name~~=~~"">'' section.~~

	<syntaxhighlight lang=xml enclose="div">		<syntaxhighlight lang=xml enclose="div">
	<favourites>		<favourites>
	<favourite name="Enter ~~Desired~~ name here" thumb="~~http://static.ddmcdn.com/gif/videos/120x90/52447.jpg~~">~~PlayMedia("plugin://plugin.video.howstuffworks_com/?url=52447&mode=playVideo")~~</favourite>		<favourite name="Enter name here" thumb="URL (local or online)">Action</favourite>
	</favourites>		</favourites>
	</syntaxhighlight >		</syntaxhighlight >



	{{Top}}		{{Top}}

	{{updated\|18}}		{{updated\|20}}
	~~[[Category:Index]]~~
	~~[[Category:Guides]]~~
	~~[[Category:Manual]]~~
	[[Category:Development]]		[[Category:Development]]
	[[Category:General topics]]		[[Category:General topics]]

Kibje: syntaxhighlighter fix

2018-07-10T12:33:37Z

syntaxhighlighter fix

← Older revision		Revision as of 12:33, 10 July 2018
Line 11:		Line 11:
	'''Example: '''		'''Example: '''
	The format of the favourites.xml is as follows. The example shows Playlist, TV Show, TV Episode, Artist, Album and Add-on.		The format of the favourites.xml is as follows. The example shows Playlist, TV Show, TV Episode, Artist, Album and Add-on.
	<syntaxhighlight lang=~~"XML"~~ enclose="div">		<syntaxhighlight lang=xml enclose="div">
	<favourites>		<favourites>
	<favourite name="Marvel Universe">ActivateWindow(10025,"special://profile/playlists/video/Marvel Universe.xsp",return)</favourite>		<favourite name="Marvel Universe">ActivateWindow(10025,"special://profile/playlists/video/Marvel Universe.xsp",return)</favourite>
Line 28:		Line 28:
	Change the name of any item by amending the ''<fabourite name="">'' section.		Change the name of any item by amending the ''<fabourite name="">'' section.

	<syntaxhighlight lang=~~"XML"~~ enclose="div">		<syntaxhighlight lang=xml enclose="div">
	<favourites>		<favourites>
	<favourite name="Enter Desired name here" thumb="http://static.ddmcdn.com/gif/videos/120x90/52447.jpg">PlayMedia("plugin://plugin.video.howstuffworks_com/?url=52447&mode=playVideo")</favourite>		<favourite name="Enter Desired name here" thumb="http://static.ddmcdn.com/gif/videos/120x90/52447.jpg">PlayMedia("plugin://plugin.video.howstuffworks_com/?url=52447&mode=playVideo")</favourite>

Karellen: Updated for v18

2018-07-04T03:58:47Z

Updated for v18

← Older revision		Revision as of 03:58, 4 July 2018
Line 1:		Line 1:
	{{mininav\| [[Userdata ~~folder~~]] {{l2\| [[Favourites]] }} }}		{{mininav\| [[Userdata]] {{l2\| [[Favourites]] }} }}

	~~This is developer~~ documentation ~~about~~ the ~~markup~~ of the favourites.xml file. For the ~~main page~~ about the favourites feature see '''[[Favourites]]'''.		<section begin="intro" />Developer documentation detailing the structure and modification of the favourites.xml file. For the User Guide about the favourites feature see '''''[[Favourites]]'''''.<section end="intro" />

	== Favourites via xml==		== Favourites via xml==
	~~Creating and/or editing~~ favourites~~.xml~~ in the ~~[[userdata folder]]~~		The '''display order''' seen in the Favourites screen is determined by the order of the entries in the xml file. Adjust the order of the favourites in the file to modify the displayed order in {{kodi}}.

	'''Example 1'''		The '''''favourites.xml''''' is located in the '''''[[Userdata]]''''' folder.
	~~Here is how simple~~ favourites.xml ~~file would like for the method outlined above if you were to create it manually~~.

			'''Example: '''
			The format of the favourites.xml is as follows. The example shows Playlist, TV Show, TV Episode, Artist, Album and Add-on.
	<syntaxhighlight lang="XML" enclose="div">		<syntaxhighlight lang="XML" enclose="div">
	<favourites>		<favourites>
	<favourite name="~~Water Wars II~~: ~~Privatization~~" thumb="~~http~~:/~~/static~~.~~ddmcdn~~.~~com~~/~~gif/videos/120x90/52447~~.jpg">~~PlayMedia~~("~~plugin~~://~~plugin~~.~~video~~.~~howstuffworks_com~~/~~?url~~=~~52447~~&~~amp~~;~~mode~~=~~playVideo~~")</favourite>		<favourite name="Marvel Universe">ActivateWindow(10025,"special://profile/playlists/video/Marvel Universe.xsp",return)</favourite>
			<favourite name="Continuum" thumb="E:\TV Show- TEST\Continuum\thumb.jpg">ActivateWindow(10025,"E:\\TV Show- TEST\\Continuum\\",return)</favourite>
			<favourite name="1x02. Fast Times" thumb="E:\TV Show- TEST\Continuum\Continuum S01E02-thumb.jpg">PlayMedia("E:\\TV Show- TEST\\Continuum\\Continuum S01E02.mkv")</favourite>
			<favourite name="Era" thumb="F:\Music\ArtistInfoKodi\Era\folder.jpg">ActivateWindow(10502,"musicdb://artists/113/?albumartistsonly=false",return)</favourite>
			<favourite name="NextPVR PVR Client" thumb="F:\Kodi v18- Nightly\addons\pvr.nextpvr\icon.png">RunAddon(pvr.nextpvr)</favourite>
			<favourite name="TV Show- TEST">ActivateWindow(10025,"E:\\TV Show- TEST\\",return)</favourite>
			<favourite name="Artist Albums">ActivateWindow(10502,"F:\\Music\\FLAC\\Artist Albums\\",return)</favourite>
	</favourites>		</favourites>
	</syntaxhighlight >		</syntaxhighlight >

	~~'''Example 2'''~~

	~~Here is how simple favourites.xml file looks like with SVN Repo Installed plugin entry (you need to have installed SVN Repo Installed and TED Video plugin previously installed):~~
	~~<syntaxhighlight lang="XML" enclose="div">~~
	~~<favourites>~~
	~~<favourite name="TED Talks" thumb="special://masterprofile/Thumbnails/Programs/d3b7311b.tbn">ActivateWindow(10024,plugin://video/TED Talks/)</favourite>~~
	~~<favourite name="SVN Repo Installer" thumb="special://home/plugins/programs/SVN Repo Installer/default.tbn">ActivateWindow(10001,plugin://programs/SVN Repo Installer/)</favourite>~~
	~~</favourites>~~
	~~</syntaxhighlight >~~

	==Renaming a favourite via xml==		==Renaming a favourite via xml==
	~~You can when adding~~ the ~~Source Name it as you wish the filename to appear, however if your not happy with~~ the name ~~provided by default rename it to whatever you wish~~.		Change the name of any item by amending the ''<fabourite name="">'' section.

	<syntaxhighlight lang="XML" enclose="div">		<syntaxhighlight lang="XML" enclose="div">
Line 33:		Line 34:
	</syntaxhighlight >		</syntaxhighlight >


			{{Top}}

			{{updated\|18}}
			[[Category:Index]]
			[[Category:Guides]]
			[[Category:Manual]]
	[[Category:Development]]		[[Category:Development]]
			[[Category:General topics]]

Uixtung: /* Favourites via xml */

2015-09-07T18:12:48Z

Favourites via xml

← Older revision		Revision as of 18:12, 7 September 2015
Line 7:		Line 7:

	'''Example 1'''		'''Example 1'''
	Here is how simple favourites.xml file would like for the method ~~outline~~ above if you were to create it manually.		Here is how simple favourites.xml file would like for the method outlined above if you were to create it manually.
	<syntaxhighlight lang="XML" enclose="div">		<syntaxhighlight lang="XML" enclose="div">
	<favourites>		<favourites>

Ned Scott at 18:10, 6 September 2015

2015-09-06T18:10:36Z

← Older revision		Revision as of 18:10, 6 September 2015
Line 1:		Line 1:
			{{mininav\| [[Userdata folder]] {{l2\| [[Favourites]] }} }}

	This is developer documentation about the markup of the favourites.xml file. For the main page about the favourites feature see '''[[Favourites]]'''.		This is developer documentation about the markup of the favourites.xml file. For the main page about the favourites feature see '''[[Favourites]]'''.

Ned Scott at 10:59, 22 April 2014

2014-04-22T10:59:42Z

← Older revision		Revision as of 10:59, 22 April 2014
Line 30:		Line 30:
	</favourites>		</favourites>
	</syntaxhighlight >		</syntaxhighlight >

			[[Category:Development]]

Ned Scott at 10:59, 22 April 2014

2014-04-22T10:59:16Z

← Older revision		Revision as of 10:59, 22 April 2014
Line 1:		Line 1:
			This is developer documentation about the markup of the favourites.xml file. For the main page about the favourites feature see '''[[Favourites]]'''.

	== Favourites via xml==		== Favourites via xml==
	Creating and/or editing favourites.xml in the [[userdata folder]]		Creating and/or editing favourites.xml in the [[userdata folder]]

Ned Scott: moved Favourites/favourites.xml to Favourites.xml

2013-06-23T01:45:30Z

moved Favourites/favourites.xml to Favourites.xml

← Older revision	Revision as of 01:45, 23 June 2013
(No difference)

>Artrafael: /* Renaming a favourite via xml */

2013-04-26T00:06:58Z

Renaming a favourite via xml

← Older revision		Revision as of 00:06, 26 April 2013
Line 21:		Line 21:

	==Renaming a favourite via xml==		==Renaming a favourite via xml==
	You can when adding the Source Name it as you wish the filename to appear, however if your not happy with the name provided by default rename it to ~~wahtever~~ you wish.		You can when adding the Source Name it as you wish the filename to appear, however if your not happy with the name provided by default rename it to whatever you wish.

	<syntaxhighlight lang="XML" enclose="div">		<syntaxhighlight lang="XML" enclose="div">

Ned Scott at 10:06, 17 March 2013

2013-03-17T10:06:27Z

← Older revision		Revision as of 10:06, 17 March 2013
Line 4:		Line 4:
	'''Example 1'''		'''Example 1'''
	Here is how simple favourites.xml file would like for the method outline above if you were to create it manually.		Here is how simple favourites.xml file would like for the method outline above if you were to create it manually.
	<~~pre~~>		<syntaxhighlight lang="XML" enclose="div">
	<favourites>		<favourites>
	<favourite name="Water Wars II: Privatization" thumb="http://static.ddmcdn.com/gif/videos/120x90/52447.jpg">PlayMedia("plugin://plugin.video.howstuffworks_com/?url=52447&mode=playVideo")</favourite>		<favourite name="Water Wars II: Privatization" thumb="http://static.ddmcdn.com/gif/videos/120x90/52447.jpg">PlayMedia("plugin://plugin.video.howstuffworks_com/?url=52447&mode=playVideo")</favourite>
	</favourites>		</favourites>
	</~~pre~~>		</syntaxhighlight >

	'''Example 2'''		'''Example 2'''

	Here is how simple favourites.xml file looks like with SVN Repo Installed plugin entry (you need to have installed SVN Repo Installed and TED Video plugin previously installed):		Here is how simple favourites.xml file looks like with SVN Repo Installed plugin entry (you need to have installed SVN Repo Installed and TED Video plugin previously installed):
	<~~pre~~>		<syntaxhighlight lang="XML" enclose="div">
	<favourites>		<favourites>
	<favourite name="TED Talks" thumb="special://masterprofile/Thumbnails/Programs/d3b7311b.tbn">ActivateWindow(10024,plugin://video/TED Talks/)</favourite>		<favourite name="TED Talks" thumb="special://masterprofile/Thumbnails/Programs/d3b7311b.tbn">ActivateWindow(10024,plugin://video/TED Talks/)</favourite>
	<favourite name="SVN Repo Installer" thumb="special://home/plugins/programs/SVN Repo Installer/default.tbn">ActivateWindow(10001,plugin://programs/SVN Repo Installer/)</favourite>		<favourite name="SVN Repo Installer" thumb="special://home/plugins/programs/SVN Repo Installer/default.tbn">ActivateWindow(10001,plugin://programs/SVN Repo Installer/)</favourite>
	</favourites>		</favourites>
	</~~pre~~>		</syntaxhighlight >

	==Renaming a favourite via xml==		==Renaming a favourite via xml==
	You can when adding the Source Name it as you wish the filename to appear, however if your not happy with the name provided by default rename it to wahtever you wish.		You can when adding the Source Name it as you wish the filename to appear, however if your not happy with the name provided by default rename it to wahtever you wish.

	<~~pre~~>		<syntaxhighlight lang="XML" enclose="div">
	<favourites>		<favourites>
	<favourite name="Enter Desired name here" thumb="http://static.ddmcdn.com/gif/videos/120x90/52447.jpg">PlayMedia("plugin://plugin.video.howstuffworks_com/?url=52447&mode=playVideo")</favourite>		<favourite name="Enter Desired name here" thumb="http://static.ddmcdn.com/gif/videos/120x90/52447.jpg">PlayMedia("plugin://plugin.video.howstuffworks_com/?url=52447&mode=playVideo")</favourite>
	</favourites>		</favourites>
	</~~pre~~>		</syntaxhighlight >