Documentation:User Guide

2011-08-23T12:41:59Z

JannaSpike:

{{RightMenu|documentation play howto toc}}

'''This document is the complete user guide for the VLC media player.'''

'' '''Note''' that most of the documentation is for versions older than 0.9''

User documentation for everyone.

*[[Documentation:Play HowTo/Introduction to VLC|Introduction to VideoLAN and VLC]]

'''       Overview and history of the VideoLAN project.'''

*[[Documentation:Play HowTo/Installing VLC|Installation]]

'''       Installation instructions for a variety of computers.''' 

*[[Documentation:Play HowTo/Basic Use|VLC Usage]]
**[[Documentation:Play_HowTo/Basic_Use/Open|Open Media]]
***How to play audio/video materials with the VLC media player. (For versions 0.9 and newer)
**[[Documentation:Play HowTo/Basic Use/Interface|Interface]]
***Short introduction to the interface of the VLC Media Player
**[[Documentation:Play HowTo/Basic Use/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 [http://mycaal.com/ loan modification] 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:Play HowTo/Basic Use 0.8| VLC Usage 0.8]]. (versions older than 0.9)

===Authors===
* Alexis de Lattre
* Johan Bilien
* Anil Daoud
* Clément Stenac
* Jean-Paul Saman
* Jean-Baptiste Kempf

Copyright (c) 2002-2009 the VideoLAN project

{{GPL}}

==See also==

*[[Documentation:Play_HowTo/Building Pages for the HTTP Interface|Building Pages for the HTTP Interface]]
*[[Documentation:Play_HowTo/Format String|Format String]]
*[[Documentation:Play_HowTo/Building Lua Playlist Scripts|Building Lua Playlist Scripts]]

{{Documentation}}

Copyright © 2002-2009 the VideoLAN project.

Documentation Talk:User Guide

2011-08-21T18:09:07Z

JannaSpike:

Import from the original doxygen documentation is finished. You can start editing it. Enjoy! [[User:Dionoea|Dionoea]] 11:12, 7 November 2006 (CET)

== Formatting: Put authors' names in the ''discussion'' page ==

I'd suggest de-emphasizing the authors of this article. For one, this will change as more authors edit this wiki. In a sense they are credited in the article's ''history'' page, but, of course, the basic principle of a wiki is that the authors are relatively anonymous.

But my suggestion is mostly based on what a reader wants to know. He/she is not so much interested in the authors as in getting information. Hence, I'd suggest the information come first in this, and all other articles, and the authors, if they need to be listed at all, be moved to the ''discussion'' pages.

Just my 2 cents...

--[[User:Jeremy Butler|Jeremy Butler]] 17:14, 9 July 2007 (CEST)
: I agree. This is mainly legacy from the old documentation (I didn't really change the layout when importing the docbook into the wiki). -- [[User:Dionoea|Dionoea]] 17:53, 9 July 2007 (CEST)
::I made the changes. Also, the GPL notice is duplicated in various templates. Perhaps it and the copyright notice should be moved to the footer. I believe that MediaWiki gives you the option of automatically inserting a GPL notice.
:::Where is it duplicated? AFAIK it's only automatically inserted if you use the Documentation template (at least that's how I planed it to work). [[User:Dionoea|Dionoea]] 18:44, 9 July 2007 (CEST)
::::[[Documentation:Play HowTo]] had it both in the template and it was at the top of the page, right after a copyright notice. I moved it to the bottom of the page, beneath the template. Based on what you've said here, I have now deleted it. If you check the history for the page, you'll see what I mean.
::::Also, can the copyright notice be moved into the footer?
::::--[[User:Jeremy Butler|Jeremy Butler]] 20:26, 9 July 2007 (CEST)
:::::I'd rather have the copyright notice right after the title (seems to be the way it's done in most manuals online). And maybe change it from (c) VideoLAN project to (c) VideoLAN project and it's contributors [[User:Dionoea|Dionoea]] 09:48, 10 July 2007 (CEST)
::::::I defer to your judgment, but you might take a look at how Gallery handles its wiki-based documentation: http://codex.gallery2.org/Gallery2:About
::::::It's got a discrete notice of the ''GNU Free Documentation License'' in the footer: "Content is available under GNU FDL." The FDL replaces the copyright notice.
::::::Also, in the US, I don't know that a group like the contributors can legally hold copyright, but I'm no lawyer. --[[User:Jeremy Butler|Jeremy Butler]] 13:15, 10 July 2007 (CEST)
:::::::Well in fact the VideoLAN project doesn't exist as a Legal entity either so theoretically it can't hold copyright either. To be on the safe side we'd need to mention all the authors in the copyright notice, with the appropriate date for each author unless they explicitly mention that they give up their copyright (or relinquish it in favor of some other legal entity). And licensing [http://mycaal.com/ loan modification] terms are a different concept from a copyright as far as I understand. (One could argue that an author keeps copyright on what he writes even if it's not stated explicitly anywhere, but I still think that we should mention it to emphasise, as do most open source projects I checked on. This page on the FSF website has some details: http://www.fsf.org/blogs/licensing/20050325novalis.html ) -- [[User:Dionoea|Dionoea]] 19:00, 10 July 2007 (CEST)
::::::::Yeah, that makes sense. But I would like to point out that what Gallery is using is the ''documentation'' license that GNU makes available here: http://www.gnu.org/copyleft/fdl.html . Thus, it's specifically designed for manuals to accompany "free software". So, depending on how "free" VideoLAN is, you might want to consider using it.
::::::::The ''GNU Free Documentation License'' does not surrender the authors' copyright. In fact, here's what they suggest you use as a copyright statement on the title page of the manual. --[[User:Jeremy Butler|Jeremy Butler]] 19:53, 10 July 2007 (CEST)
Copyright (c) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled "GNU
Free Documentation License".
:::::::::Changing the license to something that isn't GPL compliant would require the authorisation of all the current authors (that's far from being impossible ... but is it really worth it?). This is what it used to look like before I began moving the doc on the wiki: http://www.videolan.org/doc/play-howto/en/play-howto-en.html . Copying what we used there would be fine IMO. [[User:Dionoea|Dionoea]] 10:03, 11 July 2007 (CEST)
::::::::::That sounds cool to me. I was just trying to suggest some possible alternatives, but I'm no expert in software-manual copyright issues. --[[User:Jeremy Butler|Jeremy Butler]] 13:25, 11 July 2007 (CEST)

==Copyright policy==
This discussion reminds me that there's currently a redlink to [[VideoLAN Wiki:Copyrights]] on the editing form. Once the VideoLAN copyright policy is established, I guess it should be stuck in there. Also, I note that these "policy" [http://diamondlinks.net/ link building] articles are empty, too: [[VideoLAN Wiki:Privacy policy]] and [[VideoLAN Wiki:General disclaimer]]. So many details when you're putting a wiki together! Regards --[[User:Jeremy Butler|Jeremy Butler]] 19:53, 10 July 2007 (CEST)

== Original authors ==

The original authors of this documentation were:
* Alexis de Lattre
* Anil Daoud
* Benjamin Pracht
* Clément Stenac
* Jean-Paul Saman
* Antoine Cellerier

VideoLAN Wiki - User contributions [en]

Documentation:User Guide

Documentation Talk:User Guide