Help:Sound file markup

Introduction

In the context of MediaWiki, sound file markup refers to the syntax and methods used to embed and display audio files within a wiki page. This functionality is crucial for wikis that aim to provide multimedia content, enhancing the user experience by allowing the inclusion of auditory information alongside text and images.

Syntax and Usage

To include a sound file in a MediaWiki page, the following syntax is typically used:

[[File:filename.ogg|thumb|Description of the sound file]]

This markup will display a player for the sound file, allowing users to play the audio directly from the page. The thumb parameter is optional and is used to display a thumbnail image if available. The description provides context or additional information about the sound file.

Parameters

filename.ogg: The name of the sound file to be embedded. The file must be uploaded to the wiki's file repository.
thumb: An optional parameter that, when included, displays a thumbnail image associated with the sound file.
Description: A brief description of the sound file, which appears below the player.

Supported File Formats

MediaWiki supports several audio file formats, with .ogg being the most common due to its open-source nature and compatibility with Wikimedia projects. Other supported formats may include .mp3 and .wav, depending on the specific configuration of the MediaWiki installation.

Examples

Here are some examples of how sound file markup can be used in a MediaWiki page:

To embed a simple audio file:

 
  [[File:Accordion_chords-01.ogg|thumb|Accordion chords example]]

To include multiple sound files:

 
  [[File:Accordion_chords-01.ogg|thumb|First example]]
  [[File:Accordion_chords-01.ogg|thumb|Second example]]

Best Practices

When using sound file markup, consider the following best practices:

Ensure that the audio file is relevant to the content of the page.
Provide a clear and concise description for each sound file.
Use high-quality audio files to enhance the user experience.
Verify that the file format is supported by the MediaWiki installation.

Also see

References

edit

Edit WikiMD

This Sound file markup article is a stub. You can help WikiMD by expanding it.