Difference between revisions of "Documentation:Documentation"

From VideoLAN Wiki
Jump to navigation Jump to search
m (Reverted edits by Wiki0808 (Talk) to last revision by OpenIDUser13)
m (nn)
 
(112 intermediate revisions by 21 users not shown)
Line 1: Line 1:
__NOTOC__
+
{{Languages}}
 +
__NOTOC__  
 +
<!-- Beginning of the banner section -->
 +
{{Banner
 +
|welcome to=VideoLAN's Documentation
 +
|description=The reference documentation on VideoLAN's projects.
 +
<div id="articlecount" style="font-size: 90%;">Articles under the [https://www.gnu.org/copyleft/gpl.html GNU General Public License] only.</div>
 +
<!-- Default Template:Banner links show here -->
 +
}}
 +
<!-- End of the banner section -->
  
<!-- Beginning of header section -->
+
== [[Documentation:User Guide|VLC User Guide]] ==
{|style="width:100%;margin-top:0px;background-color:#fcfcfc;border:1px solid #ccc"
+
This is the {{VLC}} user documentation for everyone.
|style="width:56%;color:#000"|
 
{|style="width:280px;border:solid 0px;background:none"
 
|-
 
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
 
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Welcome to [[Documentation:Documentation|VideoLAN's&nbsp;Documentation]],</div>
 
<div style="top:+0.2em;font-size: 95%">The reference documentation on VideoLAN's projects.</div>
 
<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>
 
|}
 
|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|Read the complete table of contents]]'''.
  
''Pages in the "Documentation" namespace are part of the official VLC media player 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]]
  
''All pages in this namespace are licensed under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License].''
+
== [[:Category:Mobile_documentation|VLC documentation for mobile devices]] ==
  
'''Note: many parts of this documentation are currently outdated / obsolete. If you have good knowledge of a particular subject and feel that it could be documented better, please update the appropriate wiki page.'''
+
''Highlights:''
 +
* [[Documentation:IOS|Documentation for iOS]]
 +
* [[Documentation:Android|Documentation for Android]]
  
== [[Documentation:VLC for dummies| VLC for dummies: an introduction to VLC]] ==
+
== [[Documentation:Streaming HowTo New|VLC streaming documentation]] ==
This document will be an introduction to VLC from version 0.9.0 and above. '''UNDER CONSTRUCTION'''
+
This document explains how to stream, transcode and save streams using the VideoLAN solution.
  
== [[Documentation:Play HowTo|VLC Play HowTo]] ==
+
''NOTE: The [[Documentation:Streaming HowTo|legacy streaming documentation]] is still available for reference, if required.''
  
User documentation for everyone.
+
== [[Hacker Guide|Hacker's Guide to VLC]] ==
  
*[[Documentation:Play_HowTo/Introduction to VLC|Introduction to VideoLAN and VLC]]
+
This document details the inner workings of VLC and its source code.
**Overview and history of the VideoLAN project.
+
* [[Hacker Guide/Audio Filters|Audio Filters]]
*[[Documentation:Play_HowTo/Installing VLC|Installation]]
+
* [[Hacker Guide/Core|Core]]
**Installation instructions for a variety of computers.
+
* [[Hacker Guide/Modules source tree|Modules source tree]]
*[[Documentation:Play_HowTo/Basic Use|VLC Usage]]
+
* [[Hacker Guide/VLM Internals|VLM Internals]]
**How to play audio/video materials with the VLC media player. (For versions 0.9 and newer)
+
* [https://dl.dropboxusercontent.com/u/90125358/VLC%20Requirements%20Documentation.rar Requirements Documentation]
*[[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.
 
  
== [[Documentation:Streaming HowTo|VLC Streaming HowTo]] ==
+
== [[Documentation:Modules|The VLC Modules Index]] ==
  
This document explains how to stream, transcode and save streams using the VideoLAN solution. '''OUTDATED'''
+
This document references most of the VLC modules and their options as well as some example uses.
  
== [[Documentation:Hacker's Guide|The Hacker's Guide to VLC]] ==
 
  
This document will detail the inner workings of VLC and its source code. '''UNDER CONSTRUCTION'''
+
=== 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:Modules|The VLC Modules Index]] ==
+
{{Documentation}}
  
This document references most of the VLC modules and their options as well as some example uses. '''UNDER CONSTRUCTION (available content is up to date)'''
+
[[Category:Documentation|*]]<!-- This modifies the sortkey -->
 
 
{{Documentation}}
 

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.