Help:Sound file markup: Difference between revisions

Revision as of 15:35, 9 December 2024

File:Accordion chords-01.ogg File:Accordion chords-01.ogg File:Accordion chords-01.ogg File:Accordion chords-01.ogg Help: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.

Overview

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

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.

1. Basic Example

``` File:Example.ogg ```

This markup will display an audio player on the page, allowing users to play the sound file directly.

1. Advanced Options

You can customize the display and behavior of the audio player using additional parameters:

Autoplay: Automatically starts playing the audio when the page is loaded. Use with caution as it can be disruptive.

 ```
 File:Example.ogg
 ```

Loop: Repeats the audio file continuously.

 ```
 File:Example.ogg
 ```

Start and End Times: Play only a specific segment of the audio file.

 ```
 File:Example.ogg
 ```

Description: Add a description or caption to the audio file.

 ```
 File:Example.ogg
 ```

Uploading Sound Files

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.

Best Practices

File Format: Use Ogg Vorbis for better compatibility with MediaWiki.
File Size: Keep audio files as small as possible to reduce loading times.
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

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.
+[[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
-== Overview ==
+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.
-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 ==
+* Overview
-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 ===
+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.
-* '''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 ==
+* Syntax
-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.
-== Examples ==
+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.
-Here is an example of how to embed an audio file that will autoplay and loop:
-<code>
-[[File:Example.ogg|autoplay|loop]]
-</code>
-== Best Practices ==
+*# Basic Example
-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.
+[[File:Example.ogg]]
-* Consider accessibility and provide textual descriptions or transcripts of the audio content.
+```
+This markup will display an audio player on the page, allowing users to play the sound file directly.
+*# Advanced Options
+You can customize the display and behavior of the audio player using additional parameters:
+* '''Autoplay''': Automatically starts playing the audio when the page is loaded. Use with caution as it can be disruptive.
+  ```
+  [[File:Example.ogg|autoplay]]
+  ```
+* '''Loop''': Repeats the audio file continuously.
+  ```
+  [[File:Example.ogg|loop]]
+  ```
+* '''Start and End Times''': Play only a specific segment of the audio file.
+  ```
+  [[File:Example.ogg|start=10|end=20]]
+  ```
+* '''Description''': Add a description or caption to the audio file.
+  ```
+  [[File:Example.ogg|Description of the audio]]
+  ```
+* Uploading Sound Files
+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.
+* Best Practices
+* '''File Format''': Use Ogg Vorbis for better compatibility with MediaWiki.
+* '''File Size''': Keep audio files as small as possible to reduce loading times.
+* '''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 ==
-== See Also ==
 * [[Help:Images]]
-* [[Help:Video file markup]]
+* [[Help:Files]]
+* [[Help:Media]]
+* [[Help:Uploading files]]
+{{Help}}
-[[Category:MediaWiki documentation]]
+[[Category:MediaWiki help]]
-{{MediaWiki-stub}}