WoW:Creating AddOn dependencies - Revision history

Move page script: Move page script moved page Creating AddOn dependencies to WoW:Creating AddOn dependencies without leaving a redirect

2023-08-15T04:47:56Z

Move page script moved page Creating AddOn dependencies to Creating AddOn dependencies without leaving a redirect

← Older revision	Revision as of 04:47, 15 August 2023
(No difference)

WoWWiki>Fandyllic at 23:00, 3 November 2007

2007-11-03T23:00:37Z

← Older revision		Revision as of 23:00, 3 November 2007
Line 1:		Line 1:
	== What is a Dependent ~~Addon~~? ==		== What is a Dependent AddOn? ==

	A ~~Dependent Addon~~ is one that relies on another ~~Addon~~ or code library for it's full functionality. Generally, an ~~Addon~~ author should take into account that the user might not have the ~~Addon~~/Library required, notify the user with a single error, and suppress all other errors that might occur.		A dependent [[AddOn]] is one that relies on another AddOn or code library for it's full functionality. Generally, an AddOn author should take into account that the user might not have the AddOn/Library required, notify the user with a single error, and suppress all other errors that might occur.


	== How do I designate a Dependent ~~Addon~~? ==		== How do I designate a Dependent AddOn? ==

	In order for a user to know your ~~Addon~~ is dependent, you must document this in the .toc file:		In order for a user to know your AddOn is dependent, you must document this in the .toc file:

	Example Standalone ~~Addon~~ .toc file:		Example Standalone AddOn .toc file:

	<pre>##Interface: 1300		<pre>##Interface: 1300
	##Title: ~~myAddon~~		##Title: myAddOn
	##Description: Does stuff</pre>		##Description: Does stuff</pre>

	Example Dependent ~~Addon~~ .toc file:		Example Dependent AddOn .toc file:

	<pre>##Interface: 1300		<pre>##Interface: 1300
	##Title: ~~myAddon~~		##Title: myAddOn
	##Description: Does stuff		##Description: Does stuff
	##Dependencies: ~~ParentAddon~~, ~~OtherAddon~~</pre>		##Dependencies: ParentAddOn, OtherAddOn</pre>

	== What if other ~~Addons~~ only improve my ~~Addon~~? ==		== What if other AddOns only improve my AddOn? ==

	If an ~~Addon~~'s code is only used to somehow improve the usability/functionality of your ~~Addon~~, but is not ''required'' for it to work, you can use the "OptionalDeps:" tag in your .toc file to have those ~~Addons~~ loaded prior to your own:		If an AddOn's code is only used to somehow improve the usability/functionality of your AddOn, but is not ''required'' for it to work, you can use the "OptionalDeps:" tag in your .toc file to have those AddOns loaded prior to your own:

	<pre>##Interface: 1300		<pre>##Interface: 1300
	##Title: ~~myAddon~~		##Title: myAddOn
	##Description: Does stuff		##Description: Does stuff
	##Dependencies: ~~ParentAddon~~, ~~OtherAddon~~		##Dependencies: ParentAddOn, OtherAddOn
	##OptionalDeps: ~~MakeMyAddonCooler~~</pre>		##OptionalDeps: MakeMyAddOnCooler</pre>

	Keep in mind that you must handle any errors that may occur if the user does not have the ~~Optionally Dependent Addon~~.		Keep in mind that you must handle any errors that may occur if the user does not have the [[optionally dependent AddOn]].

	[[Category:HOWTOs\|Create AddOn Dependencies]]		[[Category:HOWTOs\|Create AddOn Dependencies]]
			[[Category:AddOns\|Create AddOn Dependencies]]

WoWWiki>Mikk: Sort key fixup.

2006-06-12T15:45:30Z

Sort key fixup.

← Older revision		Revision as of 15:45, 12 June 2006
Line 33:		Line 33:
	Keep in mind that you must handle any errors that may occur if the user does not have the Optionally Dependent Addon.		Keep in mind that you must handle any errors that may occur if the user does not have the Optionally Dependent Addon.

	[[Category:~~AddOns~~]]		[[Category:HOWTOs\|Create AddOn Dependencies]]

WoWWiki>Fandyllic at 05:51, 9 August 2005

2005-08-09T05:51:01Z

← Older revision		Revision as of 05:51, 9 August 2005
Line 32:		Line 32:

	Keep in mind that you must handle any errors that may occur if the user does not have the Optionally Dependent Addon.		Keep in mind that you must handle any errors that may occur if the user does not have the Optionally Dependent Addon.

			[[Category:AddOns]]

WoWWiki>Neogia: /* How do I designate a Dependent Addon? */

2005-03-29T22:04:30Z

How do I designate a Dependent Addon?

← Older revision		Revision as of 22:04, 29 March 2005
Line 10:		Line 10:
	Example Standalone Addon .toc file:		Example Standalone Addon .toc file:

	<~~nowiki~~>##Interface: 1300		<pre>##Interface: 1300
	##Title: myAddon		##Title: myAddon
	##Description: Does stuff</~~nowiki~~>		##Description: Does stuff</pre>

	Example Dependent Addon .toc file:		Example Dependent Addon .toc file:

	<~~nowiki~~>##Interface: 1300		<pre>##Interface: 1300
	##Title: myAddon		##Title: myAddon
	##Description: Does stuff		##Description: Does stuff
	##Dependencies: ParentAddon, OtherAddon</~~nowiki~~>		##Dependencies: ParentAddon, OtherAddon</pre>

	== What if other Addons only improve my Addon? ==		== What if other Addons only improve my Addon? ==
Line 25:		Line 25:
	If an Addon's code is only used to somehow improve the usability/functionality of your Addon, but is not ''required'' for it to work, you can use the "OptionalDeps:" tag in your .toc file to have those Addons loaded prior to your own:		If an Addon's code is only used to somehow improve the usability/functionality of your Addon, but is not ''required'' for it to work, you can use the "OptionalDeps:" tag in your .toc file to have those Addons loaded prior to your own:

	##Interface: 1300		<pre>##Interface: 1300
	##Title: myAddon		##Title: myAddon
	##Description: Does stuff		##Description: Does stuff
	##Dependencies: ParentAddon, OtherAddon		##Dependencies: ParentAddon, OtherAddon
	##OptionalDeps: MakeMyAddonCooler		##OptionalDeps: MakeMyAddonCooler</pre>

	Keep in mind that you must handle any errors that may occur if the user does not have the Optionally Dependent Addon.		Keep in mind that you must handle any errors that may occur if the user does not have the Optionally Dependent Addon.

WoWWiki>The Nerd Wonder: /* How do I designate a Dependent Addon? */ fixed formatting

2005-03-29T16:45:01Z

How do I designate a Dependent Addon?: fixed formatting

← Older revision		Revision as of 16:45, 29 March 2005
Line 10:		Line 10:
	Example Standalone Addon .toc file:		Example Standalone Addon .toc file:

	<nowiki~~><code~~>##Interface: 1300		<nowiki>##Interface: 1300
	##Title: myAddon		##Title: myAddon
	##Description: Does stuff~~</code>~~</nowiki>		##Description: Does stuff</nowiki>

	Example Dependent Addon .toc file:		Example Dependent Addon .toc file:

	<nowiki~~><code~~>##Interface: 1300		<nowiki>##Interface: 1300
	##Title: myAddon		##Title: myAddon
	##Description: Does stuff		##Description: Does stuff
	##Dependencies: ParentAddon, OtherAddon~~</code>~~</nowiki>		##Dependencies: ParentAddon, OtherAddon</nowiki>

	== What if other Addons only improve my Addon? ==		== What if other Addons only improve my Addon? ==

WoWWiki>Neogia: An Addon that relies on another Addon or code library for functionality.

2005-03-29T15:20:56Z

An Addon that relies on another Addon or code library for functionality.

New page

== What is a Dependent Addon? ==

A Dependent Addon is one that relies on another Addon or code library for it's full functionality. Generally, an Addon author should take into account that the user might not have the Addon/Library required, notify the user with a single error, and suppress all other errors that might occur.

== How do I designate a Dependent Addon? ==

In order for a user to know your Addon is dependent, you must document this in the .toc file:

Example Standalone Addon .toc file:

<nowiki><code>##Interface: 1300
##Title: myAddon
##Description: Does stuff</code></nowiki>

Example Dependent Addon .toc file:

<nowiki><code>##Interface: 1300
##Title: myAddon
##Description: Does stuff
##Dependencies: ParentAddon, OtherAddon</code></nowiki>

== What if other Addons only improve my Addon? ==

If an Addon's code is only used to somehow improve the usability/functionality of your Addon, but is not ''required'' for it to work, you can use the "OptionalDeps:" tag in your .toc file to have those Addons loaded prior to your own:

##Interface: 1300
##Title: myAddon
##Description: Does stuff
##Dependencies: ParentAddon, OtherAddon
##OptionalDeps: MakeMyAddonCooler

Keep in mind that you must handle any errors that may occur if the user does not have the Optionally Dependent Addon.