Difference between revisions of "Documentation:Documentation"

From VideoLAN Wiki
Jump to navigation Jump to search
m (nn)
 
(33 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]]  ==
 
== [[Documentation:User Guide|VLC User Guide]]  ==
User documentation for everyone.
+
This is the {{VLC}} user documentation for everyone.
  
[[Documentation:User_Guide|Go to the table of content]]
+
'''[[Documentation:User_Guide|Read the complete table of contents]]'''.
  
Highlights:
+
''Highlights:''
 
* [[Documentation:Quick_start_guide|Quick Start Guide]]
 
* [[Documentation:Quick_start_guide|Quick Start Guide]]
 
* [[Documentation:Installing_VLC|Install VLC]]
 
* [[Documentation:Installing_VLC|Install VLC]]
 
* [[Documentation:Interface|Main VLC interface]]
 
* [[Documentation:Interface|Main VLC interface]]
 +
* [[Documentation:Open_Media|Open a media file]]
 
* [[Documentation:Command_line|VLC command line]]
 
* [[Documentation:Command_line|VLC command line]]
  
== [[Documentation:Streaming HowTo|VLC Streaming Documentation]]  ==
+
== [[:Category:Mobile_documentation|VLC documentation for mobile devices]]  ==
  
This document explains how to stream, transcode and save streams using the VideoLAN solution. '''OUTDATED'''  
+
''Highlights:''
 +
* [[Documentation:IOS|Documentation for iOS]]
 +
* [[Documentation:Android|Documentation for Android]]
  
'''NOTE: See [[Documentation:Streaming HowTo New|Streaming HowTo New]] for more updated information regarding streaming (WIP).'''
+
== [[Documentation:Streaming HowTo New|VLC streaming documentation]] ==
 +
This document explains how to stream, transcode and save streams using the VideoLAN solution.
  
== [[Documentation:Hacker's Guide|The Hacker's Guide to VLC]] ==
+
''NOTE: The [[Documentation:Streaming HowTo|legacy streaming documentation]] is still available for reference, if required.''
  
This document will detail the inner workings of VLC and its source code.
+
== [[Hacker Guide|Hacker's Guide to VLC]] ==
 +
 
 +
This document details 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 54: Line 47:
  
  
 
+
=== 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.
 
'''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.