Area Header - Revision history

Cordir at 17:13, 29 April 2016

2016-04-29T17:13:21Z

← Older revision		Revision as of 17:13, 29 April 2016
Line 60:		Line 60:
	Description: This one or two paragraph summary of the zone will be accessible to players, so keep that in mind when crafting this content. You should provide basic information, but not reveal secrets.<BR>		Description: This one or two paragraph summary of the zone will be accessible to players, so keep that in mind when crafting this content. You should provide basic information, but not reveal secrets.<BR>
	Flags: These are the default settings for the zone, including the type (manmade or natural) and the terrain.<BR>		Flags: These are the default settings for the zone, including the type (manmade or natural) and the terrain.<BR>
			<BR>
			----
	If creating an area by hand, the following values MUST be used:<BR>		If creating an area by hand, the following values MUST be used:<BR>
			<BR>
	'''FORMAT''' <number> e.g. Format 2 - Specifies the format "version." In order to maintain compatibility with the standard #AREA header, the FORMAT element must be first.<BR>		'''FORMAT''' <number> e.g. Format 2 - Specifies the format "version." In order to maintain compatibility with the standard #AREA header, the FORMAT element must be first.<BR>
	<nowiki>'''*'''</nowiki> - literal asterisk. Line comment.<BR>		<nowiki>'''*'''</nowiki> - literal asterisk. Line comment.<BR>

Cordir: /* Area Header Two */

2016-04-29T17:12:27Z

Area Header Two

Cordir: /* Area Header Two */

2016-04-29T17:10:30Z

Area Header Two

← Older revision		Revision as of 17:10, 29 April 2016
Line 61:		Line 61:
	Flags: These are the default settings for the zone, including the type (manmade or natural) and the terrain.<BR>		Flags: These are the default settings for the zone, including the type (manmade or natural) and the terrain.<BR>

			If creating an area by hand, the following values MUST be used:<BR>

			FORMAT <number> e.g. Format 2 - Specifies the format "version." In order to maintain compatibility with the standard #AREA header, the FORMAT element must be first.<BR>
			* - literal asterisk. Line comment.<BR>
			AUTHOR <string name name [...]> e.g. Author Tynian Maurice IvoryTiger~ - Lists one or more author names. Among other things, the area command will search for authors. For example, Pitt is credited as a go-author for Volant, and AREA PITT will show Volant.<BR>
			DESCRIPTION <string> e.g. Description This sample area is admired by none.~<BR>
			END - Ends the #AREA block<BR>
			FLAGS <text> <text> [...] - e.g. Flags manmade city forest 16 End - Provides one or more area flags. Will also accept numerical flag numbers. Must end with 'End'.<BR>
			HIGHLEVEL <num> - e.g. Highlevel 50 - Provides the recommended highest level for the area.<BR>
			INSTALLED <YYYY-MM-DD> - e.g. Installed 2014-07-01 - Installation date.<BR>
			LOWLEVEL <num) e.g. Lowlevel 1 - Provides the recommended lowest level for the area.<BR>
			REVISION $Revision$ - The value must be this exact format. The source control program will substitute the file 'version' for $Revision$, which the game parses.<BR>
			UPDATED $Date$ - The value must be this exact format. The source control software will substitute the file last "check in" time for $Date$, which the game parses.<BR>
	[[Category:Area Development]]		[[Category:Area Development]]

Cordir: /* Area Header Two */

2016-04-29T17:08:04Z

Area Header Two

← Older revision		Revision as of 17:08, 29 April 2016
Line 52:		Line 52:

	End</pre>		End</pre>

			Fields:<BR>
			Area Name: This is the name of the zone.<BR>
			Installation Date: This is the date of original installation. This date should be populated by the Area Coordinators upon zone install.<BR>
			Revision Date: This is system generated and should not be mucked with.<BR>
			Author: This is all of the contributing authors for the zone. Separate the names with spaces. Please do not use ampersands or commas.<BR>
			Description: This one or two paragraph summary of the zone will be accessible to players, so keep that in mind when crafting this content. You should provide basic information, but not reveal secrets.<BR>
			Flags: These are the default settings for the zone, including the type (manmade or natural) and the terrain.<BR>

	[[Category:Area Development]]		[[Category:Area Development]]

Cordir at 17:05, 29 April 2016

2016-04-29T17:05:10Z

← Older revision		Revision as of 17:05, 29 April 2016
Line 25:		Line 25:

	==Area Header Two==		==Area Header Two==
			[[File:Area Header II.JPG\|200px\|thumb\|left\|the Area Header creation page on the Apprentice's Workshop]]

	In 2014, Tynian created a new format for Area Headers. It allows for the listing of multiple contributing authors as well as general information about the zone, which can be accessed using the AREA command. (E.G: AREA AERIE VOLANT) It is the preferred area header style, but the information for the classic header is retained here for historical purposes. It is also available as the default area header when creating zones in the Apprentice's Workshop area writing tool.		In 2014, Tynian created a new format for Area Headers. It allows for the listing of multiple contributing authors as well as general information about the zone, which can be accessed using the AREA command. (E.G: AREA AERIE VOLANT) It is the preferred area header style, but the information for the classic header is retained here for historical purposes. It is also available as the default area header when creating zones in the Apprentice's Workshop area writing tool.

	~~[[File:Area Header II~~.~~JPG\|200px\|thumb\|left\|~~the Area ~~Header creation page on the Apprentice's Workshop]]~~		It should be noted that the Updated date field is system generated, however the installation date is not. That date should be populated by the Area Coordinators upon zone install.

	When formatted, the header looks like this:		When formatted, the header looks like this:
Line 50:		Line 52:

	End</pre>		End</pre>

	~~It should be noted that the Updated date field is system generated, however the installation date is not. That date should be populated by the Area Coordinators upon zone install.~~

	~~The Author~~

	[[Category:Area Development]]		[[Category:Area Development]]

Cordir: added info on Area Header II

2016-04-29T17:04:13Z

added info on Area Header II

← Older revision		Revision as of 17:04, 29 April 2016
Line 1:		Line 1:
			There are two types of Area headers.

			==Basic Area Header==
	The syntax for the header is:		The syntax for the header is:

			'''A B C DE F'''

	A ~~B C DE F~~		A: This is the string "#AREA " without the quotes. Following the string, on the same line, is a bunch of text which MUST be laid out precisely in order to keep the area list in neat columns.

			B: This is the level range. It starts with a { followed by the low range followed by the high range followed by a }. The field with is 7 positions, and all must be used with { in the first position and } in the 7th.

	A: This is the ~~string "#AREA " without the quotes~~. ~~Following the string,~~		C: This is the author's name. It starts with a space in position 8, followed by up to 8 characters for the name. Unused character places should be padded with spaces. Position 17 must be a space.
	~~on the same line, is~~ a ~~bunch of text which MUST be laid out precisely~~ in
	~~order~~ to ~~keep~~ the ~~area list in neat columns~~.

			D: This is the name of the area. It starts in position 18. You are allowed up to 20 characters for the name, but you do not have to pad the unused positions with spaces.

	B: This is the ~~level range. It starts with a { followed by~~ the ~~low range~~		E: This is the tilda (the squiggly hyphen).
	~~followed by the high range followed by a }. The field with is 7 positions,~~
	~~and all must be used with { in the first position and } in the 7th~~.

			F: This is the [[Area Flags\|area wide flag]] denoting the kind of area it is. It is a letter "F" followed by a space followed by a value. The value is chosen from the appropriate part of the flag list, and these values may be combined.

	C: ~~This~~ is the ~~author's name. It starts with a space in position 8,~~		This an example of a classic area header:
	~~followed by up to 8 characters for~~ the ~~name~~. ~~Unused character places~~
	~~should be padded with spaces. Position 17 must be a space.~~		<nowiki>#AREA { 1 2} Author Area_Name~ F 1</nowiki>

			If this block is used, it is IMPERATIVE it is the FIRST line of the file.

	~~D: This is~~ the ~~name~~ of the ~~area~~. It ~~starts in position 18. You are~~		==Area Header Two==
	~~allowed up to 20 characters for~~ the ~~name~~, but ~~you do not have to pad~~ the		In 2014, Tynian created a new format for Area Headers. It allows for the listing of multiple contributing authors as well as general information about the zone, which can be accessed using the AREA command. (E.G: AREA AERIE VOLANT) It is the preferred area header style, but the information for the classic header is retained here for historical purposes. It is also available as the default area header when creating zones in the Apprentice's Workshop area writing tool.
	~~unused positions with spaces~~.

			[[File:Area Header II.JPG\|200px\|thumb\|left\|the Area Header creation page on the Apprentice's Workshop]]

	E: ~~This~~ is the ~~tilda (~~the ~~squiggly hyphen)~~.		When formatted, the header looks like this:
			<pre>
			#AREA
			Format 2
			Name Aerie Volant~
			Installed 2014-03-22
			Revision $Revision: 1.11 $
			Updated $Date: 2014/07/01 03:21:50 $
			Author Cordir Pitt Kerriariadne~
			Description
			The Aerie Volant is an Aara racial home town for the Outland Frontier,
			carved out of a white stone cliff that overlooks the Maelmordian Sea.
			It is open to all levels, but be warned - the guards are protective and
			those of other races may find there is no welcome for them here. Young
			aarakocrans living in the Aerie can frolic in the pool at the base of the
			cliff or soar high above the cliffs in the strong breezes. The abundant
			food found in the Sava River is not far away.
			~
			Flags City End

			End</pre>

	~~F: This~~ is the ~~[[Area Flags\|area wide flag]] denoting the kind of area it~~ is. ~~It is a~~		It should be noted that the Updated date field is system generated, however the installation date is not. That date should be populated by the Area Coordinators upon zone install.
	~~letter "F" followed by a space followed~~ by ~~a value. The value is chosen~~
	~~from~~ the ~~appropriate part of the flag list, and these values may be~~
	~~combined~~.

			The Author

	~~This an example of an area header:~~


	~~<nowiki>#AREA { 1 2} Author Area_Name~ F 1</nowiki>~~



	~~If this block is used, it is IMPERATIVE it is the FIRST line of the file.~~
	[[Category:Area Development]]		[[Category:Area Development]]

Natilena at 20:59, 10 May 2012

2012-05-10T20:59:15Z

← Older revision		Revision as of 20:59, 10 May 2012
Line 28:		Line 28:


	F: This is the area wide flag denoting the kind of area it is. It is a		F: This is the [[Area Flags\|area wide flag]] denoting the kind of area it is. It is a
	letter "F" followed by a space followed by a value. The value is chosen		letter "F" followed by a space followed by a value. The value is chosen
	from the appropriate part of the flag list, and these values may be		from the appropriate part of the flag list, and these values may be

Natilena: moved The Area Header to Area Header

2011-06-02T01:34:19Z

moved The Area Header to Area Header

← Older revision	Revision as of 01:34, 2 June 2011
(No difference)

Katrana at 16:34, 2 April 2011

2011-04-02T16:34:34Z

← Older revision		Revision as of 16:34, 2 April 2011
Line 42:		Line 42:

	If this block is used, it is IMPERATIVE it is the FIRST line of the file.		If this block is used, it is IMPERATIVE it is the FIRST line of the file.
			[[Category:Area Development]]

Thor: Created page with "The syntax for the header is: A B C DE F A: This is the string "#AREA " without the quotes. Following the string, on the same line, is a bunch of text which MUST be laid o..."

2011-02-12T19:57:04Z

Created page with "The syntax for the header is: A B C DE F A: This is the string "#AREA " without the quotes. Following the string, on the same line, is a bunch of text which MUST be laid o..."

New page

The syntax for the header is:

A B C DE F

A: This is the string "#AREA " without the quotes. Following the string,
on the same line, is a bunch of text which MUST be laid out precisely in
order to keep the area list in neat columns.

B: This is the level range. It starts with a { followed by the low range
followed by the high range followed by a }. The field with is 7 positions,
and all must be used with { in the first position and } in the 7th.

C: This is the author's name. It starts with a space in position 8,
followed by up to 8 characters for the name. Unused character places
should be padded with spaces. Position 17 must be a space.

D: This is the name of the area. It starts in position 18. You are
allowed up to 20 characters for the name, but you do not have to pad the
unused positions with spaces.

E: This is the tilda (the squiggly hyphen).

F: This is the area wide flag denoting the kind of area it is. It is a
letter "F" followed by a space followed by a value. The value is chosen
from the appropriate part of the flag list, and these values may be
combined.

This an example of an area header:

<nowiki>#AREA { 1 2} Author Area_Name~ F 1</nowiki>

If this block is used, it is IMPERATIVE it is the FIRST line of the file.

← Older revision		Revision as of 17:12, 29 April 2016
Line 63:		Line 63:
	If creating an area by hand, the following values MUST be used:<BR>		If creating an area by hand, the following values MUST be used:<BR>

	FORMAT <number> e.g. Format 2 - Specifies the format "version." In order to maintain compatibility with the standard #AREA header, the FORMAT element must be first.<BR>		'''FORMAT''' <number> e.g. Format 2 - Specifies the format "version." In order to maintain compatibility with the standard #AREA header, the FORMAT element must be first.<BR>
	* - literal asterisk. Line comment.<BR>		<nowiki>'''*'''</nowiki> - literal asterisk. Line comment.<BR>
	AUTHOR <string name name [...]> e.g. Author Tynian Maurice IvoryTiger~ - Lists one or more author names. Among other things, the area command will search for authors. For example, Pitt is credited as a go-author for Volant, and AREA PITT will show Volant.<BR>		'''AUTHOR''' <string name name [...]> e.g. Author Tynian Maurice IvoryTiger~ - Lists one or more author names. Among other things, the area command will search for authors. For example, Pitt is credited as a go-author for Volant, and AREA PITT will show Volant.<BR>
	DESCRIPTION <string> e.g. Description This sample area is admired by none.~<BR>		'''DESCRIPTION''' <string> e.g. Description This sample area is admired by none.~<BR>
	END - Ends the #AREA block<BR>		END - Ends the #AREA block<BR>
	FLAGS <text> <text> [...] - e.g. Flags manmade city forest 16 End - Provides one or more area flags. Will also accept numerical flag numbers. Must end with 'End'.<BR>		'''FLAGS''' <text> <text> [...] - e.g. Flags manmade city forest 16 End - Provides one or more area flags. Will also accept numerical flag numbers. Must end with 'End'.<BR>
	HIGHLEVEL <num> - e.g. Highlevel 50 - Provides the recommended highest level for the area.<BR>		'''HIGHLEVEL''' <num> - e.g. Highlevel 50 - Provides the recommended highest level for the area.<BR>
	INSTALLED <YYYY-MM-DD> - e.g. Installed 2014-07-01 - Installation date.<BR>		'''INSTALLED''' <YYYY-MM-DD> - e.g. Installed 2014-07-01 - Installation date.<BR>
	LOWLEVEL <num) e.g. Lowlevel 1 - Provides the recommended lowest level for the area.<BR>		'''LOWLEVEL''' <num) e.g. Lowlevel 1 - Provides the recommended lowest level for the area.<BR>
	REVISION $Revision$ - The value must be this exact format. The source control program will substitute the file 'version' for $Revision$, which the game parses.<BR>		'''REVISION''' $Revision$ - The value must be this exact format. The source control program will substitute the file 'version' for $Revision$, which the game parses.<BR>
	UPDATED $Date$ - The value must be this exact format. The source control software will substitute the file last "check in" time for $Date$, which the game parses.<BR>		'''UPDATED''' $Date$ - The value must be this exact format. The source control software will substitute the file last "check in" time for $Date$, which the game parses.<BR>
	[[Category:Area Development]]		[[Category:Area Development]]