Difference between revisions of "Documentation:Documentation"

From VideoLAN Wiki
Jump to navigation Jump to search
m (nn)
 
(40 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__ <!-- Beginning of header section -->
+
{{Languages}}
{|style="width:100%;margin-top:0px;background-color:#fcfcfc;border:1px solid #ccc"
+
__NOTOC__  
|style="width:56%;color:#000"|
+
<!-- Beginning of the banner section -->
{|style="width:280px;border:solid 0px;background:none"
+
{{Banner
|-
+
|welcome to=VideoLAN's Documentation
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
+
|description=The reference documentation on VideoLAN's projects.
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Welcome to [[Documentation:Documentation|VideoLAN's&nbsp;Documentation]],</div>
+
<div id="articlecount" style="font-size: 90%;">Articles under the [https://www.gnu.org/copyleft/gpl.html GNU General Public License] only.</div>
<div style="top:+0.2em;font-size: 95%">The reference documentation on VideoLAN's projects.</div>
+
<!-- Default Template:Banner links show here -->
<div id="articlecount" style="width:100%;text-align:center;font-size:85%;">Articles under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License] only.</div>
+
}}
|}
+
<!-- End of the banner section -->
|style="width:11%;font-size:95%;color:#000" valign="top"|
 
*[[VideoLAN|VideoLAN]]
 
*[[VLC|VLC media player]]
 
*[[Documentation:Documentation|Documentation]]
 
|style="width:14%;font-size:95%" valign="top"|
 
*[http://www.videolan.org Main Site]
 
*[http://forum.videolan.org Forum]
 
*[http://planet.videolan.org News from developers]
 
|style="width:18%;font-size:95%" valign="top"|
 
*[http://www.videolan.org/developers/ Developer's website]
 
*[http://nightlies.videolan.org Latest builds]
 
*[http://trac.videolan.org Trac, Bugs, SVN and roadmap]
 
|}
 
<!-- end of the header section -->
 
  
 +
== [[Documentation:User Guide|VLC User Guide]]  ==
 +
This is the {{VLC}} user documentation for everyone.
  
'''Note: Parts of this documentation are currently outdated or incomplete. If you have good knowledge of a particular subject and feel that it could be documented better, please update the appropriate wiki page.'''
+
'''[[Documentation:User_Guide|Read the complete table of contents]]'''.
  
== [[Documentation:Play HowTo|VLC Usage Documentation]] ==
+
''Highlights:''
 +
* [[Documentation:Quick_start_guide|Quick Start Guide]]
 +
* [[Documentation:Installing_VLC|Install VLC]]
 +
* [[Documentation:Interface|Main VLC interface]]
 +
* [[Documentation:Open_Media|Open a media file]]
 +
* [[Documentation:Command_line|VLC command line]]
  
User documentation for everyone.
+
== [[:Category:Mobile_documentation|VLC documentation for mobile devices]]  ==
  
*[[Documentation:Play HowTo/Introduction to VLC|Introduction to VideoLAN and VLC]]
+
''Highlights:''
 +
* [[Documentation:IOS|Documentation for iOS]]
 +
* [[Documentation:Android|Documentation for Android]]
  
'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Overview and history of the VideoLAN project.'''
+
== [[Documentation:Streaming HowTo New|VLC streaming documentation]]  ==
 +
This document explains how to stream, transcode and save streams using the VideoLAN solution.
  
*[[Documentation:Play HowTo/Installing VLC|Installation]]
+
''NOTE: The [[Documentation:Streaming HowTo|legacy streaming documentation]] is still available for reference, if required.''
  
'''&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Installation instructions for a variety of computers.'''<br>
+
== [[Hacker Guide|Hacker's Guide to VLC]] ==
  
*[[Documentation:Play HowTo/Basic Use|VLC Usage]]
+
This document details the inner workings of VLC and its source code.
**How to play audio/video materials with the VLC media player. (For versions 0.9 and newer)
 
**[[Documentation:Interface|Interface]]
 
***Short introduction to the interface of the VLC Media Player
 
**[[Documentation:Audio|Audio]]
 
***Playing audio (e.g. visualization, selection of devices)
 
**[[Documentation:Play HowTo/Basic Use/Video|Video]]
 
***Playing video (e.g. cropping, screen-/snapshots)
 
**[[Documentation:Play HowTo/Basic Use/Playback|Playback]]
 
***Navigation through media files (e.g. chapters, bookmarks)
 
**[[Documentation:Play HowTo/Basic Use/Playlist|Playlist]]
 
***Creating and managing playlists
 
**[[Documentation:Play HowTo/Basic Use/Subtitles|Subtitles]]
 
***Selection of subtitles
 
**[[Documentation:Play HowTo/Basic Use/Video and Audio Filters|Video and Audio Filters]]
 
***Usage of VLC's filters (equalizer, video filters)
 
**[[Documentation:Play HowTo/Basic Use/Snapshots|Snapshots]]
 
***How to create snap-/screenshots
 
**[[Documentation:Play HowTo/Basic Use/Hotkeys|Hotkeys]]
 
***Configuration of VLC's hotkeys
 
**[[Documentation:Play HowTo/Basic Use/Basic troubleshooting|Troubleshooting]]
 
***Solutions for some common problems
 
*[[Documentation:Play HowTo/Advanced Use of VLC|Advanced Use]]
 
**Advanced instruction on streams, filters, plug-ins and more.
 
*[[Documentation:WebPlugin|Using VLC inside a webpage]]
 
**How to build webpages that use the VLC Web plugin.
 
*[[VLC Uninstall|Uninstallation]]
 
**Uninstallation instructions.
 
 
 
== [[Documentation:Streaming HowTo|VLC Streaming Documentation]]  ==
 
 
 
This document explains how to stream, transcode and save streams using the VideoLAN solution. '''OUTDATED'''
 
 
 
'''NOTE: See [[Documentation:Streaming HowTo New|Streaming HowTo New]] for more updated information regarding streaming (WIP).'''
 
 
 
== [[Documentation:Hacker's Guide|The Hacker's Guide to VLC]] ==
 
 
 
This document will detail the inner workings of VLC and its source code.
 
 
* [[Hacker Guide/Audio Filters|Audio Filters]]
 
* [[Hacker Guide/Audio Filters|Audio Filters]]
 
* [[Hacker Guide/Core|Core]]
 
* [[Hacker Guide/Core|Core]]
 
* [[Hacker Guide/Modules source tree|Modules source tree]]
 
* [[Hacker Guide/Modules source tree|Modules source tree]]
 
* [[Hacker Guide/VLM Internals|VLM Internals]]
 
* [[Hacker Guide/VLM Internals|VLM Internals]]
 +
* [https://dl.dropboxusercontent.com/u/90125358/VLC%20Requirements%20Documentation.rar Requirements Documentation]
  
 
== [[Documentation:Modules|The VLC Modules Index]] ==
 
== [[Documentation:Modules|The VLC Modules Index]] ==
Line 86: Line 46:
 
This document references most of the VLC modules and their options as well as some example uses.
 
This document references most of the VLC modules and their options as well as some example uses.
  
 +
 +
=== Contribute to the documentation ===
 +
'''Nota Bene:''' Parts of this documentation are currently outdated or incomplete. If you have good knowledge or feel that you could document it better, please update the appropriate wiki page.
  
 
{{Documentation}}
 
{{Documentation}}
 +
 +
[[Category:Documentation|*]]<!-- This modifies the sortkey -->

Latest revision as of 05:54, 27 April 2019

VLC User Guide

This is the VLC media player user documentation for everyone.

Read the complete table of contents.

Highlights:

VLC documentation for mobile devices

Highlights:

VLC streaming documentation

This document explains how to stream, transcode and save streams using the VideoLAN solution.

NOTE: The legacy streaming documentation is still available for reference, if required.

Hacker's Guide to VLC

This document details the inner workings of VLC and its source code.

The VLC Modules Index

This document references most of the VLC modules and their options as well as some example uses.


Contribute to the documentation

Nota Bene: Parts of this documentation are currently outdated or incomplete. If you have good knowledge or feel that you could document it better, please update the appropriate wiki page.

This page is part of official VLC media player Documentation (User GuideStreaming HowToHacker GuideModules)
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.