The wiki: Difference between revisions

From NeoGeo Development Wiki
Jump to navigation Jump to search
mNo edit summary
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Main rule==
=Main rule=


Knowledge isn't an excuse for being a dick. Keep your ego at the door, please. By posting information here, you know that it's going in the wild. If you want credit, you can sign (important) information, but don't expect people to care about it.
Knowledge isn't an excuse for being a dick. Keep your ego at the door, please :)


==How to edit==
=Content directives=
 
* By posting information here, you know that it's going in the wild. If you want credit, you can sign (important) information, but don't expect people to care about it.
* No advertising for commercial products.
* No personal infos, except names of key people who already have their names publicly known.
* No non-technical infos about games (price, story, characters, gameplay, ...). Other websites exist for that.
 
=How to edit=
 
See https://meta.wikimedia.org/wiki/Help:Reference_card


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:
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).
*Pages can be created, edited or deleted by any registered user. All operations are logged and can be reverted ("view history" tab).
*Each edit is signed by your username in the history list.
*Each edit is signed by your username and a timestamp.
*Links to existing pages are in blue or purple, links to needed pages are in red.
*Links to existing pages are in blue, links to needed pages are in red.
*Clicking on the "Show preview" button won't log anything, "Save page" will.
*When editing, 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.
*Marking an edit as "minor" allows to find important changes in logs and correct typos without having the update appear on the front page.
*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.
*As stated in all edit pages: the content you submit will be placed under the [http://www.gnu.org/licenses/fdl-1.3.en.html GNU FDL]. This is not the best place to keep things secret.


Mediawiki uses a special markup language for formatting:
Mediawiki uses a special markup language for formatting:
Line 23: Line 32:
*'''Bold''' looks like <nowiki>'''this'''</nowiki>, ''Italic'' looks like <nowiki>''this''</nowiki> (those are apostrophes)
*'''Bold''' looks like <nowiki>'''this'''</nowiki>, ''Italic'' looks like <nowiki>''this''</nowiki> (those are apostrophes)
*Headlines are made by using = characters: =Title= is the biggest, ====Title==== is the smallest
*Headlines are made by using = characters: =Title= is the biggest, ====Title==== is the smallest
*Summaries are automatically generated for pages containing multiple headlines
*Table of contents are automatically generated for pages containing multiple headlines
*Categorizing a page is done by adding tags like this: <nowiki>[[Category:Category_name]]</nowiki>, a page can belong in multiple categories.
*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.
*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.
Line 29: Line 38:




*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.
*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 don'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...
*Member pages can be created and edited only by the associated member. These can hold informations about yourself, your current projects...


Line 35: Line 44:


*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.
*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.
*Try to 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).
*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.
*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 wrong information.
*Don't hesitate to sign the informations you add if you think you discovered something or to specify the source if not.
*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".
*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).
*Links to other pages should ideally be made only 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.
*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''' !
*Don't forget that the Neogeo is a console, and that a console is obviously made to earn money but also for '''fun''' !


==Templates==
=Templates=
 
==CSS==
 
Common.css can be found here: [https://wiki.neogeodev.org/index.php?title=MediaWiki:Common.css].


===Binary register definitions===
==Binary register definitions==


[[Template:16BitRegister]] and [[Template:8BitRegister]] can be used to display such tables:
[[Template:16BitRegister]] and [[Template:8BitRegister]] can be used to display such tables:
Line 55: Line 68:
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.
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.


===Registers, RAM locations and signal names===
==Link templates==


The [[Template:Reg]] and [[Template:BR]] are used to refer to named registers and RAM locations. Their address is automatically added in parenthesis. For example:
===Register===
[[Template:Reg]]. Parameters: register name (not the address).


<pre><nowiki>{{BR|BIOS_UPSIZE}}</nowiki></pre>
===Signal===
[[Template:Sig]]. Parameters: signal name, anchor name in [[signal names]] page, signal polarity ("N", "P", or nothing).


Gives: {{BR|BIOS_UPSIZE}}
===RAM location===
[[Template:BR]]. Parameters: location name (not the address).


[[Template:Sig]] is used to refer to electrical signals and provide a link to the [[signal names]] page for details.
===Chip===
[[Template:Chipname]]. Parameters: chip name/reference.


===Chip pinout templates===
===PCB===
[[Template:PCB]]. Parameters: board reference.


ODG (OpenOffice Draw) files:
=Chip pinout templates=
* 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.
The OpenOffice Draw format was previously used but a move to plain SVG is being made. See the [[https://github.com/neogeodev/SVGPinout SVGPinout NeoGeoDev repo]] to learn how to edit and generate pinouts easily.


Color proposals for buses and pin types (feel free to discuss):
Color proposals for buses and pin types (feel free to discuss):
*<span style="background-color:green;color:white;">Green: cartridge slot connections</span>
*<span style="background-color:green;color:white;">Green: cartridge slot connections or graphics data</span>
*<span style="background-color:yellow;">Yellow: CPU address buses</span>
*<span style="background-color:yellow;">Yellow: address buses</span>
*<span style="background-color:blue;color:white;">Blue: data buses</span>
*<span style="background-color:blue;color:white;">Blue: data buses</span>
*<span style="background-color:lightgrey;">Grey: ground</span>
*<span style="background-color:lightgrey;">Grey: ground</span>
Line 81: Line 97:
*<span style="background-color:purple;color:white;">Purple: control lines</span>
*<span style="background-color:purple;color:white;">Purple: control lines</span>
*<span style="background-color:magenta;color:white;">Magenta: clocks</span>
*<span style="background-color:magenta;color:white;">Magenta: clocks</span>
*<span style="background-color:white;color:black;">White: NC (dotted), unknown, others...</span>

Latest revision as of 16:02, 29 June 2018

Main rule

Knowledge isn't an excuse for being a dick. Keep your ego at the door, please :)

Content directives

  • By posting information here, you know that it's going in the wild. If you want credit, you can sign (important) information, but don't expect people to care about it.
  • No advertising for commercial products.
  • No personal infos, except names of key people who already have their names publicly known.
  • No non-technical infos about games (price, story, characters, gameplay, ...). Other websites exist for that.

How to edit

See https://meta.wikimedia.org/wiki/Help:Reference_card

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. All operations are logged and can be reverted ("view history" tab).
  • Each edit is signed by your username and a timestamp.
  • Links to existing pages are in blue, links to needed pages are in red.
  • When editing, clicking on the "Show preview" button won't log anything, "Save page" will.
  • Marking an edit as "minor" allows to find important changes in logs and correct typos without having the update appear on the front page.
  • 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
  • Table of contents 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 don'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.
  • Try to 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 wrong 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 ideally be made only 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

CSS

Common.css can be found here: [1].

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.

Link templates

Register

Template:Reg. Parameters: register name (not the address).

Signal

Template:Sig. Parameters: signal name, anchor name in signal names page, signal polarity ("N", "P", or nothing).

RAM location

Template:BR. Parameters: location name (not the address).

Chip

Template:Chipname. Parameters: chip name/reference.

PCB

Template:PCB. Parameters: board reference.

Chip pinout templates

The OpenOffice Draw format was previously used but a move to plain SVG is being made. See the [SVGPinout NeoGeoDev repo] to learn how to edit and generate pinouts easily.

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

  • Green: cartridge slot connections or graphics data
  • Yellow: address buses
  • Blue: data buses
  • Grey: ground
  • Red: power
  • Purple: control lines
  • Magenta: clocks
  • White: NC (dotted), unknown, others...