Help:Editing guidelines - Revision history

Zink at 05:47, 9 May 2013

2013-05-09T05:47:05Z

← Older revision		Revision as of 05:47, 9 May 2013
Line 2:		Line 2:

	Remember that you can always look at the sources of already existing pages, copy their code and modify it to make new pages. You don't have to know all of this all the time (in fact I don't!). This page exists mainly as a reference of how it ''should'' be done.		Remember that you can always look at the sources of already existing pages, copy their code and modify it to make new pages. You don't have to know all of this all the time (in fact I don't!). This page exists mainly as a reference of how it ''should'' be done.

			Also, some solutions used in the LBA File Info wiki are not quite well cooperating with the wiki's native caching mechanism. This may cause some pages not to be refreshed when they should be. If you sumble upon the case (particularly after the edit of a page), you can click the button next to the ''View history'' button, and choose ''Refresh'' from the menu.

	== Namespaces ==		== Namespaces ==

Zink at 10:06, 29 April 2013

2013-04-29T10:06:55Z

@@ Line 1: / Line 1: @@
 This page describes standards, structures and techniques that are utilised in this wiki. It is recommended to conform to these in order to maintain information consistency and accessibility. However, nothing bad will happen if you do not. The standards are not tightly settled nor thoroughly thought, however they were changed many times through the page development, and are still imperfect. This means that they may changed again if there is a need for that. This also means that the rules may be broken whenever it is reasonable. Feel free to discuss the issues and ideas on the ''discussion'' pages.
 == Namespaces ==
@@ Line 207: / Line 209: @@
 == Program pages ==

Zink at 09:31, 29 April 2013

2013-04-29T09:31:26Z

← Older revision		Revision as of 09:31, 29 April 2013
Line 171:		Line 171:
	== Entry pages ==		== Entry pages ==

			Each HQR entry may have its own page, but it is not required. If the page exists, ''ht auto'' or automatic model can be used for the owner HQR page, and all necessary properties should be defined. For easy describing the template [[Template:entry page\|entry page]] is available. Here is an example:

			<pre>
			{{entry page\|1\|LBA1:Ress.hqr\|0
			\| content =
			\| entry type = Normal
			\| file type = Colour palette
			\| size = 768 bytes
			\| compression = 0
			\| providers = [[provider::El Muerte]] and [[provider::alexfont]]
			\| text =
			This is the main game palette which its used for all the sprites, bricks, 3D models and menu background image.

			=== Content ===
			[[File:PaletaLBA1.png]]
			}}
			</pre>

			The main and required parameters (right after the template name) are:
			# '''LBA version''' - 1 or 2
			# '''Owner HQR file''' (including the namespace)
			# '''entry index''' - always starting with zero

			After that the named parameters may be defined. They are optional, but highly recommended:
			* '''function''' - will be shown in the ''Entry function'' column in the entries list.
			* '''content''' - will be shown in the ''Entry content'' column in the entries list.
			* '''entry type''' - Normal, Hidden, Repeated or Blank
			* '''file type''' - type of the extracted file (name of the file type page)
			* '''size''' - original size of the file
			* '''compression''' - original compression of the file (0, 1 or 2)
			* '''providers''' - list of people that provided information about this entry
			* '''text''' - description of the entry. It may be long and may use wiki text formatting. In the above example there is a header and a picture. Picture, sound, and other files may be uploaded to the wiki and attached to the pages. Refer to the [http://www.mediawiki.org/wiki/Help:Images Mediawiki help] for more information.

			For the entry pages there should be no text outside of the ''entry page'' template, because it would appear after the providers list, which we don't want. All necessary categorization is done automatically.

	== Program pages ==		== Program pages ==

Zink at 07:59, 29 April 2013

2013-04-29T07:59:48Z

@@ Line 111: / Line 111: @@
 * '''count1''', '''count2'''... - in manual model it is necessary to manually define counts of the file types in addition to ''type1'', and so on.
-Note that in the manual model there is no ''providers'' parameter. This is because the providers must be described manually at the end of the page. But before that, and after the ''hqr page'' template, the actual entries must be defined. For that, the two templates exist: [[Template:ht|ht]] and [[Template:ht auto|ht auto]].
+Note that in the manual model there is no ''providers'' parameter. This is because the providers must be described manually at the end of the page. But before that, and after the ''hqr page'' template, the actual entries must be defined. For that, the two templates exist: [[Template:ht|ht]] and [[Template:ht auto|ht auto]], which can be mixed on one page.
-=== ht ===
+=== Template: ht ===
 Ht template defines one row of the manual entries table (i.e. one entry). Its params are following:
 # '''Entry index''' (always starting with 0)
@@ Line 119: / Line 119: @@
 # '''File type''' - name of the file type page (e.g. ''LBA2:Wave file'')
 # '''Entry function''' - describes what purpose the entry serves in the game. From this text a link to the possible entry wiki page will be created automatically (thus it is important to keep it unique across HQR files within namespace). If the param is left empty then no link will be created, and in the ''function'' table column the word ''Unknown'' will be put.
-# '''Entry content''' - should be a short description of what's inside the entry (e.g. ''Adeline logo''). This field does not have to be unique.
+# '''Entry content''' - should be a short description of what's inside the entry (e.g. ''Adeline logo''). This field does not have to be unique. If empty, the ''Entry function'' field will be used (but without linking).
-There are also named parameters that are fully optional, and can be placed in any position between numbered params:
+There are also named parameters that can be placed in any position between numbered params:
-* '''r''' - for repeated entries this param should be set to index (starting with 0) of the entry this one repeats. The index will be shown in the ''Type'' column.
+* '''r''' - for repeated entries only - this param should be set to index (starting with 0) of the entry this one repeats. The index will be shown in the ''Type'' column.
 * '''cl''' - abbreviation of ''Content Link'', it can be set to 1. If so, the link to the entry page will be created from the ''Entry function'' field, but the target page name will be taken from ''Entry content'' field.
 {{ht| 35|Normal|LBA1:Animation|Animation  35|cl=1|Twinsen fighting with sword (normal mode) animation}}
 == Entry pages ==

Zink at 12:13, 26 April 2013

2013-04-26T12:13:47Z

← Older revision		Revision as of 12:13, 26 April 2013
Line 101:		Line 101:
	\| blank = 250		\| blank = 250
	\| type1 = LBA2:Wave file \| count1 = 48		\| type1 = LBA2:Wave file \| count1 = 48

	\| text =		\| text =
	This file contains ''item found'' description voices.		This file contains ''item found'' description voices.
Line 114:		Line 113:
	Note that in the manual model there is no ''providers'' parameter. This is because the providers must be described manually at the end of the page. But before that, and after the ''hqr page'' template, the actual entries must be defined. For that, the two templates exist: [[Template:ht\|ht]] and [[Template:ht auto\|ht auto]].		Note that in the manual model there is no ''providers'' parameter. This is because the providers must be described manually at the end of the page. But before that, and after the ''hqr page'' template, the actual entries must be defined. For that, the two templates exist: [[Template:ht\|ht]] and [[Template:ht auto\|ht auto]].

			=== ht ===
	* '''ht''' template defines one row of the manual entries table (i.e. one entry)		Ht template defines one row of the manual entries table (i.e. one entry). Its params are following:
			# '''Entry index''' (always starting with 0)
			# '''Entry type''' (''Normal'', ''Hidden'', ''Repeated'' or ''Blank'')
			# '''File type''' - name of the file type page (e.g. ''LBA2:Wave file'')
			# '''Entry function''' - describes what purpose the entry serves in the game. From this text a link to the possible entry wiki page will be created automatically (thus it is important to keep it unique across HQR files within namespace). If the param is left empty then no link will be created, and in the ''function'' table column the word ''Unknown'' will be put.
			# '''Entry content''' - should be a short description of what's inside the entry (e.g. ''Adeline logo''). This field does not have to be unique.

			There are also named parameters that are fully optional, and can be placed in any position between numbered params:
			* '''r''' - for repeated entries this param should be set to index (starting with 0) of the entry this one repeats. The index will be shown in the ''Type'' column.
			* '''cl''' - abbreviation of ''Content Link'', it can be set to 1. If so, the link to the entry page will be created from the ''Entry function'' field, but the target page name will be taken from ''Entry content'' field.

			{{ht\| 35\|Normal\|LBA1:Animation\|Animation 35\|cl=1\|Twinsen fighting with sword (normal mode) animation}}

	== Entry pages ==		== Entry pages ==

Zink at 09:01, 26 April 2013

2013-04-26T09:01:01Z

← Older revision		Revision as of 09:01, 26 April 2013
Line 112:		Line 112:
	* '''count1''', '''count2'''... - in manual model it is necessary to manually define counts of the file types in addition to ''type1'', and so on.		* '''count1''', '''count2'''... - in manual model it is necessary to manually define counts of the file types in addition to ''type1'', and so on.

	Note that in the manual model there is no ''providers'' parameter. This is because the providers must be described manually at the end of the page. But before that, and after the ''hqr page'' template, the actual entries must be defined.		Note that in the manual model there is no ''providers'' parameter. This is because the providers must be described manually at the end of the page. But before that, and after the ''hqr page'' template, the actual entries must be defined. For that, the two templates exist: [[Template:ht\|ht]] and [[Template:ht auto\|ht auto]].

			* '''ht''' template defines one row of the manual entries table (i.e. one entry)

Zink at 08:39, 26 April 2013

2013-04-26T08:39:26Z

← Older revision		Revision as of 08:39, 26 April 2013
Line 88:		Line 88:
	* '''text''' - description of the HQR file. It may be long, may contain formatting, wiki text, and templates. The description text should not appear outside of the template, because the template puts entries table and providers list after it. Thus, there is nothing more a HQR page should contain.		* '''text''' - description of the HQR file. It may be long, may contain formatting, wiki text, and templates. The description text should not appear outside of the template, because the template puts entries table and providers list after it. Thus, there is nothing more a HQR page should contain.

	The example below describes a '''manual''' presentation model (types list is not complete). It uses the same template, but in a different way.		The example below describes a '''manual''' presentation model (types list is not complete). It uses the same template, but in a different way. Most of the new template parameters apply to both automatic and manual modes.

	<pre>		<pre>
			{{DISPLAYTITLE:LBA2:xx_gam.vox
	{{hqr page		}}{{hqr page
			\| ResType = VOX
	\| mode = manual		\| mode = manual
	\| lba = 2		\| lba = 2
	\| hqr file = ~~LBA2:ress~~.~~hqr~~		\| hqr file = (EN,DE,FR)_gam.vox
	\| normal = 32		\| normal = 47
	\| ~~repeated~~ = 8		\| hidden = 1
	\| blank = 9		\| blank = 250
	\| type1 = ~~Sprite actor data~~ \| count1 = 1		\| type1 = LBA2:Wave file \| count1 = 48

	\| type2 = In-game font \| count2 = 1
	\| type3 = Colour palette \| count3 = 3
	\| type4 = LBA2:3D model \| count4 = 1
	\| text =		\| text =
	This file contains ~~various~~ ~~game~~ ~~resources:~~ ~~the font, images, textures, some generic models, etc~~.		This file contains ''item found'' description voices.
	}}		}}
	</pre>		</pre>

	* '''mode''' - defines the presentation model (template mode). In this case the mode must be explicitly set to ''manual''.		* '''mode''' - defines the presentation model (template mode). In this case the mode must be explicitly set to ''manual''.
			* '''ResType''' - defines resource file type (HQR, VOX, ILE or OBL). This is used so that breadcrumbs box will display link to the proper resource category.
	* '''
			* '''hqr file''' - defines name of the HQR file the page is for, if the file name is different than the page name. This is also used only for breadcrumbs. This parameter is necessary only if the HQR file name cannot be directly used as a wiki page name, because of the underscore "_"character in the file name. Wiki engine uses the underscore as a replacement for space and vice-versa, so if a page is named with an underscore, it will be displayed with a space instead. If the hqr file is defined, the breadcrumbs will use it instead of the page name. Wiki also always capitalizes the first letter of each article, and this parameter also solves that, if necessary. In connection to that, there is the ''DISPLAYTITLE'' magic word before the template, which does the same as ''hqr file'' param, but for the shown page title. This one uses the wiki built-in mechanism to allow for overriding default page title display conventions. Note that this can be used for these two issues only - capital first letter, and spaces instead of underscores. It will not work if the desired display title has more differences from original page name (that's why the explicit namespace is required here).
			* '''count1''', '''count2'''... - in manual model it is necessary to manually define counts of the file types in addition to ''type1'', and so on.

			Note that in the manual model there is no ''providers'' parameter. This is because the providers must be described manually at the end of the page. But before that, and after the ''hqr page'' template, the actual entries must be defined.



	== Entry pages ==		== Entry pages ==

Zink at 06:39, 26 April 2013

2013-04-26T06:39:41Z

← Older revision		Revision as of 06:39, 26 April 2013
Line 64:		Line 64:
	* '''Manual model''' - works so each entry is described manually in the HQR page's source. This makes it easy to create HQR pages containing hundreds of entries, because the entry pages do not have to exist. Disadvantage of this model is that when a described entry page is created (to give more details on that entry), the HQR page will most likely need an update with that entry. Also if the file format of an entry is changed, one will have to manually update the HQR format counters.		* '''Manual model''' - works so each entry is described manually in the HQR page's source. This makes it easy to create HQR pages containing hundreds of entries, because the entry pages do not have to exist. Disadvantage of this model is that when a described entry page is created (to give more details on that entry), the HQR page will most likely need an update with that entry. Also if the file format of an entry is changed, one will have to manually update the HQR format counters.

	For easier creation a special template is present, called [[Template:hqr page\|hqr page]]. Below is an example usage:		For easier creation a special template is present, called [[Template:hqr page\|hqr page]]. Below is an example usage (types list is not complete):

	<pre>		<pre>
Line 84:		Line 84:
	* '''lba''' - LBA version (1 or 2)		* '''lba''' - LBA version (1 or 2)
	* '''providers''' - list of people that discovered the information about the HQR file. Each name must be an [http://semantic-mediawiki.org/wiki/Help:Properties_and_types#Creating_properties SMW property set statement]. In future this may be used for statistics, and browsing information by providers.		* '''providers''' - list of people that discovered the information about the HQR file. Each name must be an [http://semantic-mediawiki.org/wiki/Help:Properties_and_types#Creating_properties SMW property set statement]. In future this may be used for statistics, and browsing information by providers.
	* '''normal''', '''blank''', '''repeated''', '''hidden''' - describe number of entries of each type in the HQR (values of 0 can be omitted). ''Hidden'' value is an exception, because it does not have to be a numerical value. For pages like [[LBA1:xx_005.vox]] the number of		* '''normal''', '''blank''', '''repeated''', '''hidden''' - describe number of entries of each type in the HQR (values of 0 can be omitted). ''Hidden'' value is an exception, because it does not have to be a numerical value. For pages like [[LBA1:xx_005.vox]] the number of hidden entries may vary between language versions (that page in fact describes three files: ''en_005.hqr'', ''de_005.hqr'' and ''fr_005.hqr''), so the ''hidden'' field contains range ''1 - 3'' (hidden entries are not included in the total count).
			* '''type1''', '''type2'''... - list of file types that exist inside the HQR, this list is used to build file types table (counts are computed automatically).
			* '''text''' - description of the HQR file. It may be long, may contain formatting, wiki text, and templates. The description text should not appear outside of the template, because the template puts entries table and providers list after it. Thus, there is nothing more a HQR page should contain.

			The example below describes a '''manual''' presentation model (types list is not complete). It uses the same template, but in a different way.

	<pre>		<pre>
Line 98:		Line 102:
	\| type3 = Colour palette \| count3 = 3		\| type3 = Colour palette \| count3 = 3
	\| type4 = LBA2:3D model \| count4 = 1		\| type4 = LBA2:3D model \| count4 = 1
	\| type5 = LBA image \| count5 = 26
	\| type6 = LBA2:Movie index \| count6 = 1
	\| type7 = LBA2:Shape file \| count7 = 1
	\| type8 = LBA2:Entity information \| count8 = 1
	\| type9 = Unknown entry \| count9 = 14

	\| text =		\| text =
	This file contains various game resources: the font, images, textures, some generic models, etc.		This file contains various game resources: the font, images, textures, some generic models, etc.
	}}		}}
	</pre>		</pre>

			* '''mode''' - defines the presentation model (template mode). In this case the mode must be explicitly set to ''manual''.
			* '''

	== Entry pages ==		== Entry pages ==

Zink at 05:44, 26 April 2013

2013-04-26T05:44:26Z

@@ Line 60: / Line 60: @@
 == HQR pages ==
-Each HQR (VOX, ILE, OBL) page has its own page, which contains description, various information, and list of the entries stored inside the file. There are two ''presentation models'' possible:
+Each HQR (VOX, ILE, OBL) file has its own page, which contains description, various information, and list of entries stored inside the file. There are two ''presentation models'' possible:
 * '''Automatic model''' - works so each HQR entry has its own page, that defines its properties, and HQR page contains only general Semantic Mediawiki query that fetches all appropriate pages automatically. This model highly depends on the Semantic Mediawiki extension features. Entry pages define properties, like index, name, extension, etc. for each entry, and HQR page reads the properties and puts them into the entries table. This model requires ''all'' entries of the HQR to have their own pages.
 * '''Manual model''' - works so each entry is described manually in the HQR page's source. This makes it easy to create HQR pages containing hundreds of entries, because the entry pages do not have to exist. Disadvantage of this model is that when a described entry page is created (to give more details on that entry), the HQR page will most likely need an update with that entry. Also if the file format of an entry is changed, one will have to manually update the HQR format counters.
 == Entry pages ==

Zink at 11:12, 25 April 2013

2013-04-25T11:12:57Z

← Older revision		Revision as of 11:12, 25 April 2013
Line 55:		Line 55:
	* ''colour'' = colour the extension will have in various lists (like entries list in a HQR page). The colour is in HTML notation, but without the # mark (named colours are not allowed).		* ''colour'' = colour the extension will have in various lists (like entries list in a HQR page). The colour is in HTML notation, but without the # mark (named colours are not allowed).
	* ''defaultsort'' - sets the wiki's <nowiki>{{DEFAULTSORT:xxx}}</nowiki> directive, which is used to change the way the page will be sorted in category listings. In this example, without defaultsort, the page would appear under ''L'' (because the page name is ''LBA image''). The defaultsort param makes it appear under ''I''.		* ''defaultsort'' - sets the wiki's <nowiki>{{DEFAULTSORT:xxx}}</nowiki> directive, which is used to change the way the page will be sorted in category listings. In this example, without defaultsort, the page would appear under ''L'' (because the page name is ''LBA image''). The defaultsort param makes it appear under ''I''.

			Format pages should contain format specification, if it is known.

	== HQR pages ==		== HQR pages ==

			Each HQR (VOX, ILE, OBL) page has its own page, which contains description, various information, and list of the entries stored inside the file. There are two ''presentation models'' possible:
			* '''Automatic model''' - works so each HQR entry has its own page, that defines its properties, and HQR page contains only general Semantic Mediawiki query that fetches all appropriate pages automatically. This model highly depends on the Semantic Mediawiki extension features. Entry pages define properties, like index, name, extension, etc. for each entry, and HQR page reads the properties and puts them into the entries table. This model requires ''all'' entries of the HQR to have their own pages.
			* '''Manual model''' - works so each entry is described manually in the HQR page's source. This makes it easy to create HQR pages containing hundreds of entries, because the entry pages do not have to exist. Disadvantage of this model is that when a described entry page is created (to give more details on that entry), the HQR page will most likely need an update with that entry. Also if the file format of an entry is changed, one will have to manually update the HQR format counters.



	== Entry pages ==		== Entry pages ==