Help:Sound file markup: Difference between revisions

Latest revision as of 00:49, 10 December 2024

Introduction[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

References[edit]

For help with this template, please post a comment on the template talk page with a {{reply to}} one or more of the == History of Sound file markup ==

.

@@ Line 1: / Line 1: @@
-[[File:Accordion chords-01.ogg|thumb]] [[File:Accordion chords-01.ogg|thumb]] [[File:Accordion chords-01.ogg|thumb]] [[File:Accordion chords-01.ogg|thumb]] Help:Sound file markup
+{{Infobox sound file
+| name = Sound File Markup
+| image = [[File:Accordion_chords-01.ogg|thumb]]
+| caption = Example of sound file markup
+}}
-Sound file markup in MediaWiki allows users to embed audio files within wiki pages. This feature is particularly useful for educational content, language learning, and any other context where audio can enhance the understanding of the material. This article provides a comprehensive guide on how to use sound file markup effectively in MediaWiki.
+== Introduction ==
-* Overview
+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.
-MediaWiki supports the inclusion of sound files through the use of specific markup. These files can be played directly on the page, providing an interactive experience for users. The most common file formats supported are Ogg Vorbis and MP3, although support may vary depending on the configuration of the MediaWiki installation.
+== Syntax and Usage ==
-* Syntax
+To include a sound file in a MediaWiki page, the following syntax is typically used:
-To include a sound file in a MediaWiki page, you use the `[[File:filename.ogg]]` syntax, where `filename.ogg` is the name of the audio file you wish to embed. The file must be uploaded to the wiki or be available on a shared repository like Wikimedia Commons.
+<code><nowiki>
+[[File:filename.ogg|thumb|Description of the sound file]]
+</nowiki></code>
-*# Basic Example
+This markup will display a player for the sound file, allowing users to play the audio directly from the page. The <code>thumb</code> 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 ===
-[[File:Example.ogg]]
-```
-This markup will display an audio player on the page, allowing users to play the sound file directly.
+* <code>filename.ogg</code>: The name of the sound file to be embedded. The file must be uploaded to the wiki's file repository.
+* <code>thumb</code>: An optional parameter that, when included, displays a thumbnail image associated with the sound file.
+* <code>Description</code>: A brief description of the sound file, which appears below the player.
-*# Advanced Options
+== Supported File Formats ==
-You can customize the display and behavior of the audio player using additional parameters:
+MediaWiki supports several audio file formats, with <code>.ogg</code> being the most common due to its open-source nature and compatibility with Wikimedia projects. Other supported formats may include <code>.mp3</code> and <code>.wav</code>, depending on the specific configuration of the MediaWiki installation.
-* '''Autoplay''': Automatically starts playing the audio when the page is loaded. Use with caution as it can be disruptive.
+== Examples ==
-  ```
-  [[File:Example.ogg|autoplay]]
-  ```
-* '''Loop''': Repeats the audio file continuously.
+Here are some examples of how sound file markup can be used in a MediaWiki page:
-  ```
-  [[File:Example.ogg|loop]]
-  ```
-* '''Start and End Times''': Play only a specific segment of the audio file.
+* To embed a simple audio file:
+   <code><nowiki>
-   ```
+   [[File:Accordion_chords-01.ogg|thumb|Accordion chords example]]
-   [[File:Example.ogg|start=10|end=20]]
+   </nowiki></code>
-   ```
-* '''Description''': Add a description or caption to the audio file.
+* To include multiple sound files:
+   <code><nowiki>
-   ```
+   [[File:Accordion_chords-01.ogg|thumb|First example]]
-   [[File:Example.ogg|Description of the audio]]
+   [[File:Accordion_chords-01.ogg|thumb|Second example]]
-   ```
+   </nowiki></code>
-* Uploading Sound Files
+== Best Practices ==
-Before you can use a sound file in your MediaWiki page, it must be uploaded to the wiki. This is typically done through the "Upload file" link in the sidebar. Ensure that the file format is supported and that you have the necessary permissions to upload files.
+When using sound file markup, consider the following best practices:
-* 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.
-* '''File Format''': Use Ogg Vorbis for better compatibility with MediaWiki.
+* Use high-quality audio files to enhance the user experience.
-* '''File Size''': Keep audio files as small as possible to reduce loading times.
+* Verify that the file format is supported by the MediaWiki installation.
-* '''Licensing''': Ensure that you have the right to use and distribute the audio file.
-* '''Accessibility''': Provide transcripts or descriptions for users who cannot hear the audio.
-* Troubleshooting
-* '''File Not Playing''': Check if the file format is supported and that the file is not corrupted.
-* '''Player Not Displaying''': Ensure that the file is correctly linked and that the MediaWiki installation supports audio playback.
 == Also see ==
@@ Line 69: / Line 59: @@
 * [[Help:Media]]
 * [[Help:Uploading files]]
+== References ==
+* [[MediaWiki User's Guide]]
+* [[Wikimedia Commons:File types]]
 {{Help}}
-[[Category:MediaWiki help]]
+[[Category:MediaWiki Help]]