Batocera-specific Code Snippets

In-links refer to linking to another page on this wiki. When doing so, you don't need to include the "https://wiki.batocera.org/" at the start, just the namespace, followed by a colon (:), and then the page name. For example:

Here's a link to the syntax page in the "wiki" namespace.

which is coded as:

[[wiki:syntax|Here's a link to the syntax page in the "wiki" namespace.]]

If you're referring to a page that doesn't belong to a namespace, remember to use a lone colon at the start so it will work no matter which page the user is looking at it from. For example:

This in-link won't work from particular other pages as there's no colon. But this one will always work.

which is coded as:

[[access_the_batocera_via_ssh|This in-link won't work from particular other pages as there's no colon.]] [[:access_the_batocera_via_ssh|But this one will always work]].

You are encouraged to use in-links over hard-coded links, as that will allow the wiki to automatically update the link should the page name ever change in the future.

If you'd like to link to a particular section in the page, add a hash (#) followed by the name of the section in all lower-case and with under-scores replacing spaces (special characters are usually just completely omitted). For example:

This links to the "links" section of the syntax page.

which is coded as:

[[wiki:syntax#links|This links to the "links" section of the syntax page.]]

For links that simply refer to another section in the same page that you're current on, you only need to specify the header name preceded by a hash:

[[#in-links|section in the same page that you're current on]]

Sections are identified by their name alone, irrelevant of how nested they are inside of other headers. If there are multiple sections with the same name in the same page, they are identified by having a digit added to the end of them.

Images can be added to a page if needed. Keep in mind that visuals should be in addition to the written explanation, not a replacement. The syntax is the following:

{{:image-name?Size|Alternative Text}}

For example, the “north button” image is located at https://wiki.batocera.org/_media/wiki:north.png (wiki:north.png is the name), it is the North button on a controller, which corresponds to the X Button on a SNES pad, and if we want to display this image at a 20 width pixel size, we need to put {{:wiki:north.png?nolink&20|North button (X SNES)}} and the wiki will show instead. Also if the image fails to load, or if we use the mouse cursor on it, it'll display “North button (X SNES)”; this is important for accessibility too.

Symbol	Code	Note
	{{:switch-button.png?20|On/Off Settings}}	The ON/OFF switch used for some options in EmulationStation.
	{{:switch-slider.png?30|}}	The slider used for some options in EmulationStation.
	{{::switch-multioption.png?20|}}	Indicates that the menu item is used to show the user information.
	{{:switch-az.png?20|}}	A sorting type used by EmulationStation.
	{{:wiki:north.png?nolink&20|North button (X SNES)}}	The “X” button on a SNES layout, also referred to as the North button.
	{{:wiki:west.png?nolink&20|West button (Y SNES)}}	The “Y” button on a SNES layout, also referred to as the West button.
	{{:wiki:south.png?nolink&20|South button (B SNES)}}	The “B” button on a SNES layout, also referred to as the South button.
	{{:wiki:east.png?nolink&20|East button (A SNES)}}	The “A” button on a SNES layout, also referred to as the East button.

Icons can be created and distributed for free with: https://logomakr.com/

Scalable Vector Graphics (SVG) files are also good for creating/editing iconography. These can be edited with Illustrator or the freely distributed Inkscape.

Sample SVG file:

Let's face it, Wikipedia is a great source of information for technical aspects at times. If you ever need to link to a Wikipedia page specifically, you should use the "wp>(title of Wikipedia page)" format for its link. For example:

Here's their page on home video-game console generations.

which is invoked by

[[wp>Home_video_game_console_generations|Here's their page on home video-game console generations.]]

Note that you don't need to include the full URL, just the Wikipedia page title. It also appears with the Wikipedia icon, isn't that neat?

Code can be displayed by using the <code>print (“Hello World”)</code> but it will lead to a grey box. So for some one liners you can try to use

%%print ("Hello World")%%

You can create downloadable files by specifying its file-name as a parameter in the <code> header along with its syntax. eg.

<code java script.js>
Here is my Javascript code.
</code>

would become

script.js

Here is my Javascript code.

If you just want a raw text file without syntax highlighting, use a hyphen (-) as your syntax.

It is also possible to ask the wiki to not apply formatting to a specific element by surrounding it by %%, or by using <nowiki></nowiki>

For example, writing down the following:

echo 'jambon' >> sandwich.txt

will display as

echo 'jambon' » sandwich.txt

transforming the >> into a », however writing

%%echo 'jambon' >> sandwich.txt%% or <nowiki>echo 'jambon' >> sandwich.txt</nowiki> will display it correctly.

The more common way of displaying tables in this wiki is through the use of vertical bars (|) and carats (^). These keys are available with [Shift]+[\] and [Shift]+[6] on standard QWERTY ASCII keyboards.

Headers are identified by beginning with a carat. Regular elements begin with vertical bars. Elements that aren't closed with another carat or bar will be discarded. For example:

^ Header 1 ^ Attribute 2 ^ Notes ^
| Emulator 1 | ''.zip'' ''.nes'' | Is pretty cool. |
| Emulator 2 | ''.nes'' | Is cooler, but less compatible. |
| Emulator 3 |
| Emulator 4

would appear as

Alignment is handled by using double white spaces on the side of the element you want it to align to. For example:

|  This element at the top isn't a header, and is right aligned. | An empty element is below this one. |
^ But this one is. Headers don't have to only be at the top, but should in most cases.  ^ |
^ Any element can be closed with either a bar or a carat, it doesn't matter which. |  But they will decide the element type for the next element. |

would appear as

One easy way to display a table is to use a comma separated values (csv) structure. Think of it like a 2-D spreadsheet, but in a pure text format where the separator of the columns is a Comma, and the separator for the lines is a newline, and the first line serves as a header.

Putting a CSV structure inside the <csv></csv> elements will display it, so for instance, if you have

Emulator name, Emulated system, Original manufacturer
Picodrive, Master system/Genesis, Sega
Genesis plus GX, Master system/Genesis, Sega

and add the <csv></csv> like this :

<csv>
Emulator name, Emulated system, Original manufacturer
Picodrive, Master system/Genesis, Sega
Genesis plus GX, Master system/Genesis, Sega
</csv>

it will then display as this

<csv file=https://docs.google.com/spreadsheets/URL/pub?output=csv>
</csv>