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: @@
-'''Help:Sound file markup''' is a guide for users on how to incorporate and manipulate sound files within [[MediaWiki]] articles. This feature enhances the multimedia capabilities of the wiki, allowing for a richer user experience by providing auditory content alongside textual information.
+{{Infobox sound file
+| name = Sound File Markup
+| image = [[File:Accordion_chords-01.ogg|thumb]]
+| caption = Example of sound file markup
+}}
-== Overview ==
+== Introduction ==
-Sound file markup in MediaWiki utilizes specific syntax to embed audio files directly into pages. This capability is crucial for educational topics, such as language pronunciation, music examples, or any subject where audio provides additional value beyond text and images.
-== Embedding Audio Files ==
+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.
-To embed an audio file in a MediaWiki page, the basic syntax used is:
-<code>
-[[File:Filename.extension|options]]
-</code>
-Where ''Filename.extension'' refers to the name and format of the audio file, and ''options'' can include parameters such as "noicon", "autoplay", and "loop". These options control the appearance and behavior of the audio player in the article.
-=== Options ===
+== Syntax and Usage ==
-* '''noicon''' - This option removes the speaker icon that typically accompanies an embedded audio file.
-* '''autoplay''' - Causes the audio file to start playing as soon as the page loads. Use of this option should be limited as it can affect user experience negatively.
-* '''loop''' - Allows the audio file to repeat indefinitely.
-== Supported Formats ==
+To include a sound file in a MediaWiki page, the following syntax is typically used:
-MediaWiki supports various audio file formats, but the most commonly used are MP3, OGG, and WAV. The choice of format can affect the compatibility and performance of the audio playback on different devices and browsers.
+<code><nowiki>
+[[File:filename.ogg|thumb|Description of the sound file]]
+</nowiki></code>
+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 ===
+* <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.
+== Supported File Formats ==
+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.
 == Examples ==
-Here is an example of how to embed an audio file that will autoplay and loop:
-<code>
+Here are some examples of how sound file markup can be used in a MediaWiki page:
-[[File:Example.ogg|autoplay|loop]]
-</code>
+* To embed a simple audio file:
+  <code><nowiki>
+  [[File:Accordion_chords-01.ogg|thumb|Accordion chords example]]
+  </nowiki></code>
+* To include multiple sound files:
+  <code><nowiki>
+  [[File:Accordion_chords-01.ogg|thumb|First example]]
+  [[File:Accordion_chords-01.ogg|thumb|Second example]]
+  </nowiki></code>
 == Best Practices ==
-When using sound files in articles, it is important to consider the following:
-* Ensure that the use of audio is relevant and adds value to the content.
-* Be mindful of file sizes as large files can slow down page loading times.
-* Consider accessibility and provide textual descriptions or transcripts of the audio content.
-== See Also ==
+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 ==
 * [[Help:Images]]
-* [[Help:Video file markup]]
+* [[Help:Files]]
+* [[Help:Media]]
+* [[Help:Uploading files]]
+== References ==
+* [[MediaWiki User's Guide]]
+* [[Wikimedia Commons:File types]]
+{{Help}}
-[[Category:MediaWiki documentation]]
+[[Category:MediaWiki Help]]
-{{MediaWiki-stub}}