Difference between revisions of "Documentation:Documentation"

From VideoLAN Wiki
Jump to navigation Jump to search
(Let's start a hacker's guide)
m (nn)
 
(143 intermediate revisions by 32 users not shown)
Line 1: Line 1:
Welcome to the VideoLAN wiki's Documentation main page. Pages in the "Documentation" namespace are part of the "Official" VLC media player documentation.
+
{{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 -->
  
All pages in this namespace are licensed under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License].
+
== [[Documentation:User Guide|VLC User Guide]] ==
 +
This is the {{VLC}} user documentation for everyone.
  
'''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.'''
+
'''[[Documentation:User_Guide|Read the complete table of contents]]'''.
  
== [[Documentation:Play HowTo|VLC Play HowTo]] ==
+
''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]]
  
This document is the complete user guide for the client aspects of VLC.
+
== [[:Category:Mobile_documentation|VLC documentation for mobile devices]]  ==
  
== [[Documentation:Streaming HowTo|VLC Streaming HowTo]] ==
+
''Highlights:''
 +
* [[Documentation:IOS|Documentation for iOS]]
 +
* [[Documentation:Android|Documentation for Android]]
  
 +
== [[Documentation:Streaming HowTo New|VLC streaming documentation]]  ==
 
This document explains how to stream, transcode and save streams using the VideoLAN solution.
 
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 it's 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/Core|Core]]
 +
* [[Hacker Guide/Modules source tree|Modules source tree]]
 +
* [[Hacker Guide/VLM Internals|VLM Internals]]
 +
* [https://dl.dropboxusercontent.com/u/90125358/VLC%20Requirements%20Documentation.rar Requirements Documentation]
 +
 
 +
== [[Documentation:Modules|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.
  
 
{{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.