The wiki: Difference between revisions

Revision as of 03:26, 3 November 2012

How to edit

For those who are unfamiliar with wiki editing and don't want to go through lenghty tutorials, here's a short summary of the basics:

Pages can be created, edited or deleted by any registered user. Any actions are logged and can be reverted (history tab).
Each edit is signed by your username in the history list.
Links to existing pages are in blue or purple, links to needed pages are in red.
Clicking on the "Show preview" button won't log anything, "Save page" will.
Marking an edit as "minor" allows to differenciate important changes in logs and correct typos.
As stated in all edit pages: the content you submit will be placed under the GNU FDL. This is not the best place to keep things secret.

Mediawiki uses a special markup language for formatting:

Links to other pages look like this: [[Page name]]
They can be renamed like this: [[Page name|Link text]]
Links to categories look like this: [[:Category:Category name]] and can also be renamed with a |.
Links to other sites look like this: [[http://www.com This is an external link]]
Pictures can be inserted like this: [[File:image.jpg|thumb|This is a thumbnail and will be placed on the right]]
Or simply like this, to display them in full size: [[File:image.jpg]]
Bold looks like '''this''', Italic looks like ''this'' (those are apostrophes)
Headlines are made by using = characters: =Title= is the biggest, ====Title==== is the smallest
Summaries are automatically generated for pages containing multiple headlines
Categorizing a page is done by adding tags like this: [[Category:Category_name]], a page can belong in multiple categories.
Tables are made using characters: {| starts a table, | starts a new cell, |- starts a new line, |} ends a table. Each of those characters need to be at the start of a new line.
CSS and HTML markup can also be used most of the time.

To create a page, just type its URL or make a link to it and click "create". There can't be 404 errors here, any link to pages or files which doesn't exist give a "create" page.
Member pages can be created and edited only by the associated member. These can hold informations about yourself, your current projects...

Editing guidelines

To avoid creating duplicate pages, page names shouldn't contain upper case letters, except for the first one and for acronyms. Intra-wiki links are case sensitive.
Also keep page names singular.
To avoid broken links to pictures or screenshots, please make a local copy by uploading them here (be sure you have the right to).
If a picture has to be updated with major corrections (like a chip pinout for example), try to delete the wrong version as to avoid search engines linking to bad information.
Don't hesitate to sign the informations you add if you think you discovered something or to specify the source if not.
It's perfectly okay to make 2-characters edit to correct English mistakes for example, as long as those edits are marked as "minor".
Links to other pages should only be made once in a page (where it's the most visible or relevant if possible).
Category tags should be placed at the bottom of the pages sources.
Don't forget that the Neogeo is a console, and that a console is obviously made to earn money but also for fun !

Templates

Binary register definitions

Template:16BitRegister and Template:8BitRegister can be used to display such tables:

Bit	15	14	13	12	11	10	9	8	7	6	5	4	3	2	1	0
Def	High byte								Lower byte

The code for this one is:

{{16BitRegister|High byte|8|Lower byte|8}}

Arguments go by pairs: starting from 0, even ones are the text definition, odd ones are the size of it (in bits). The total size must be equal to the register's length or else the table will be broken and browsers might be unhappy.

Chip pinout templates

ODG (OpenOffice Draw) files:

QFP80 package: http://furrtek.free.fr/noclass/neogeo/neo-zmc2.odg
QFP64 package: http://furrtek.free.fr/noclass/neogeo/neo-257.odg

Grid is at 0.05", font is Courier New size 6.

Color proposals for buses and pin types (feel free to discuss):

Green: cartridge slot connections
Yellow: CPU address buses
Blue: data buses
Grey: ground
Red: VCC
Purple: control lines

@@ Line 3: / Line 3: @@
 For those who are unfamiliar with wiki editing and don't want to go through lenghty tutorials, here's a short summary of the basics:
-*Pages can be created, edited or deleted by any registered user.
+*Pages can be created, edited or deleted by any registered user. Any actions are logged and can be reverted (history tab).
-*The host (wikki.com) only permits image files to be uploaded.
-*There's an history system ("history" tab) for every modifiable element that allows to follow, track and/or cancel any modifications. The history lists can't be deleted.
 *Each edit is signed by your username in the history list.
 *Links to existing pages are in blue or purple, links to needed pages are in red.
-*Clicking on the "Show preview" button won't log anything, "Save page" will. Marking an edit as "minor" allows to differenciate important changes in logs.
+*Clicking on the "Show preview" button won't log anything, "Save page" will.
+*Marking an edit as "minor" allows to differenciate important changes in logs and correct typos.
 *As stated in all edit pages: the content you submit will be placed under the GNU FDL. This is not the best place to keep things secret.
 Mediawiki uses a special markup language for formatting:
-*Links to other pages look like this: <nowiki>[[Page_name]]</nowiki>
+*Links to other pages look like this: <nowiki>[[Page name]]</nowiki>
-*They can be renamed like this: <nowiki>[[Page_name|Link text]]</nowiki>
+*They can be renamed like this: <nowiki>[[Page name|Link text]]</nowiki>
 *Links to categories look like this: <nowiki>[[:Category:Category name]]</nowiki> and can also be renamed with a |.
 *Links to other sites look like this: <nowiki>[[http://www.com This is an external link]]</nowiki>
-*Pictures can be inserted like this: <nowiki>[[File:image.jpg|thumb|This is a thumbnail and will be placed on the left]]</nowiki>
+*Pictures can be inserted like this: <nowiki>[[File:image.jpg|thumb|This is a thumbnail and will be placed on the right]]</nowiki>
 *Or simply like this, to display them in full size: <nowiki>[[File:image.jpg]]</nowiki>
 *'''Bold''' looks like <nowiki>'''this'''</nowiki>, ''Italic'' looks like <nowiki>''this''</nowiki> (those are apostrophes)
@@ Line 24: / Line 22: @@
 *Categorizing a page is done by adding tags like this: <nowiki>[[Category:Category_name]]</nowiki>, a page can belong in multiple categories.
 *Tables are made using characters: {| starts a table, | starts a new cell, |- starts a new line, |} ends a table. Each of those characters need to be at the start of a new line.
+*CSS and HTML markup can also be used most of the time.
@@ Line 32: / Line 31: @@
 *To avoid creating duplicate pages, page names shouldn't contain upper case letters, except for the first one and for acronyms. Intra-wiki links are case sensitive.
+*Also keep page names singular.
 *To avoid broken links to pictures or screenshots, please make a local copy by uploading them here (be sure you have the right to).
-*If a picture has to be updated with minor aesthetical modifications, please delete the older version (files aren't automatically overwritten).
+*If a picture has to be updated with major corrections (like a chip pinout for example), try to delete the wrong version as to avoid search engines linking to bad information.
 *Don't hesitate to sign the informations you add if you think you discovered something or to specify the source if not.
 *It's perfectly okay to make 2-characters edit to correct English mistakes for example, as long as those edits are marked as "minor".
-*Links to another page should only be made once in a page (where it's the most visible or relevant if possible).
+*Links to other pages should only be made once in a page (where it's the most visible or relevant if possible).
 *Category tags should be placed at the bottom of the pages sources.
 *Don't forget that the Neogeo is a console, and that a console is obviously made to earn money but also for '''fun''' !