Commit 13774f7d authored by Alexis de Lattre's avatar Alexis de Lattre

ALL : reorganized the way images are handleed by the documentation.

Added a paragraph in the intro about how to access the command line
under Windows and Linux.
parent a5f71e7a
......@@ -36,7 +36,7 @@ display MPEG streams under multiple operating systems.</para>
<figure><title>Global VideoLAN solution</title>
<mediaobject>
<imageobject>
<imagedata fileref="plan-videolan-640.&magic;" format="&magic;" scalefit="1" scale="60">
<imagedata fileref="images/plan-videolan.&magic;" format="&magic;" scalefit="1" scale="60">
</imageobject>
</mediaobject>
</figure>
......@@ -226,18 +226,63 @@ server <emphasis>irc.freenode.net</emphasis>, channel
url="http://www.videolan.org/support/bug-reporting.html">bug reporting
page</ulink>.</para>
<sect1><title>Convention</title>
<sect1><title>Command line vs. graphical interfaces</title>
<simplesect><title>Windows users</title>
<para>VLC has many different graphical interfaces, that are organized
quite differently in order to be in harmony with the guidelines of
each Operating System supported. Documenting the use of each graphical
interface is too long, and some features are only available via the
command line interface. Therefore we decided to document only the
command line interface, but in many cases it shouldn't be difficult to
guess how to use the graphical interface for the same use !</para>
<para>Some features are currently only available using
the command line interface of VLC. To run such commands, use the Windows
command line tool.</para>
<sect2><title>Open a command tool</title>
<simplesect><title>Unix users</title>
<simplesect><title>under Windows</title>
<para>Unix systems users : in this document, we adopt the following
conventions for the Unix commands :</para>
<para>Click on <emphasis>Start</emphasis>, <emphasis>Run</emphasis> and
type :</para>
<itemizedlist>
<listitem><para><command>cmd</command> and <keycap>Enter</keycap> under
Windows 2000 / XP,</para>
<listitem><para><command>command</command> and <keycap>Enter</keycap>
under Windows 95 / 98 / ME.</para>
</itemizedlist>
<para>The command tool appears :</para>
<figure><title>Windows command tool</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/cmd-windows.&magic;" format="&magic;" scalefit="1" scale="60">
</imageobject>
</mediaobject>
</figure>
<para>Then go to directory where you installed VLC :</para>
<screen>
<prompt># </prompt><userinput>cd C:\Program Files\VLC\</userinput>
</screen>
<simplesect><title>under Linux or Unix</title>
<para>Under X, open a terminal :</para>
<figure><title>Windows command tool</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/cmd-linux.&magic;" format="&magic;" scalefit="1" scale="60">
</imageobject>
</mediaobject>
</figure>
<para>In the documentation, we adopt the following conventions for the
Unix commands :</para>
<itemizedlist>
......@@ -256,3 +301,12 @@ conventions for the Unix commands :</para>
</screen>
</itemizedlist>
<simplesect><title>under Mac OS X</title>
<para>[TODO]</para>
<simplesect><title>under BeOS</title>
<para>[TODO]</para>
all: clean html ps pdf rtf txt
# Makefile for the VideoLAN Documentation
DOC := videolan-howto
# We build HTML, PS, PDF, RTF and TXT for the Web site
all: images html ps pdf rtf txt
# Get the images from the /images/documentation directory
images:
rm -rf images
cp -R ../../images/documentation images
html:
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b html -s ../common/stylesheet-html.dsl videolan-howto.sgml
mv videolan-howto/*.html .
rmdir videolan-howto
sgmltools -b html -s ../common/stylesheet-html.dsl $(DOC).sgml
mv $(DOC)/*.html .
rmdir $(DOC)
ln -sf book1.html index.html
zip videolan-howto-html.zip *.html *.jpg
rm -f $(DOC)-html.zip
zip $(DOC)-html.zip *.html images/*.jpg
ps:
/bin/cp ../common/magic-eps.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.eps .
sgmltools -b ps -s ../common/stylesheet-print.dsl videolan-howto.sgml
zip videolan-howto-ps.zip videolan-howto.ps
sgmltools -b ps -s ../common/stylesheet-print.dsl $(DOC).sgml
zip $(DOC)-ps.zip $(DOC).ps
pdf:
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b pdf -s ../common/stylesheet-print-noicones.dsl videolan-howto.sgml
zip videolan-howto-pdf.zip videolan-howto.pdf
sgmltools -b pdf -s ../common/stylesheet-print-noicones.dsl $(DOC).sgml
zip $(DOC)-pdf.zip $(DOC).pdf
rtf:
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b rtf -s ../common/stylesheet-print-noicones.dsl videolan-howto.sgml
zip videolan-howto-rtf.zip videolan-howto.rtf *.jpg
sgmltools -b rtf -s ../common/stylesheet-print-noicones.dsl $(DOC).sgml
rm -f $(DOC)-rtf.zip
zip $(DOC)-rtf.zip $(DOC).rtf images/*.jpg
txt:
sgmltools -b txt videolan-howto.sgml
sgmltools -b txt $(DOC).sgml
clean:
rm -f *.zip *.html *.pdf *.ps *.txt *.rtf
all: clean html ps pdf rtf txt
# Makefile for the VideoLAN Documentation
DOC := videolan-quickstart
# We build HTML, PS, PDF, RTF and TXT for the Web site
all: images html ps pdf rtf txt
# Get the images from the /images/documentation directory
images:
rm -rf images
cp -R ../../images/documentation images
html:
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b html -s ../common/stylesheet-html.dsl videolan-quickstart.sgml
mv videolan-quickstart/*.html .
rmdir videolan-quickstart
sgmltools -b html -s ../common/stylesheet-html.dsl $(DOC).sgml
mv $(DOC)/*.html .
rmdir $(DOC)
ln -sf book1.html index.html
zip videolan-quickstart-html.zip *.html *.jpg
rm -f $(DOC)-html.zip
zip $(DOC)-html.zip *.html images/*.jpg
ps:
/bin/cp ../common/magic-eps.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.eps .
sgmltools -b ps -s ../common/stylesheet-print.dsl videolan-quickstart.sgml
zip videolan-quickstart-ps.zip videolan-quickstart.ps
sgmltools -b ps -s ../common/stylesheet-print.dsl $(DOC).sgml
zip $(DOC)-ps.zip $(DOC).ps
pdf:
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b pdf -s ../common/stylesheet-print-noicones.dsl videolan-quickstart.sgml
zip videolan-quickstart-pdf.zip videolan-quickstart.pdf
sgmltools -b pdf -s ../common/stylesheet-print-noicones.dsl $(DOC).sgml
zip $(DOC)-pdf.zip $(DOC).pdf
rtf:
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b rtf -s ../common/stylesheet-print-noicones.dsl videolan-quickstart.sgml
zip videolan-quickstart-rtf.zip videolan-quickstart.rtf *.jpg
sgmltools -b rtf -s ../common/stylesheet-print-noicones.dsl $(DOC).sgml
rm -f $(DOC)-rtf.zip
zip $(DOC)-rtf.zip $(DOC).rtf images/*.jpg
txt:
sgmltools -b txt videolan-quickstart.sgml
sgmltools -b txt $(DOC).sgml
clean:
rm -f *.zip *.html *.pdf *.ps *.txt
rm -f *.zip *.html *.pdf *.ps *.txt *.rtf
all: clean html ps pdf rtf txt
# Makefile for the VideoLAN Documentation
DOC := vlc-user-guide
# We build HTML, PS, PDF, RTF and TXT for the Web site
all: images html ps pdf rtf txt
# Get the images from the /images/documentation directory
images:
rm -rf images
cp -R ../../images/documentation images
html:
rm -f *.html
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b html -s ../common/stylesheet-html.dsl vlc-user-guide.sgml
mv vlc-user-guide/*.html .
rmdir vlc-user-guide
sgmltools -b html -s ../common/stylesheet-html.dsl $(DOC).sgml
mv $(DOC)/*.html .
rmdir $(DOC)
ln -sf book1.html index.html
zip vlc-user-guide-html.zip *.html *.jpg
rm -f $(DOC)-html.zip
zip $(DOC)-html.zip *.html images/*.jpg
ps:
/bin/cp ../common/magic-eps.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.eps .
sgmltools -b ps -s ../common/stylesheet-print.dsl vlc-user-guide.sgml
zip vlc-user-guide-ps.zip vlc-user-guide.ps
sgmltools -b ps -s ../common/stylesheet-print.dsl $(DOC).sgml
zip $(DOC)-ps.zip $(DOC).ps
pdf:
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b pdf -s ../common/stylesheet-print-noicones.dsl vlc-user-guide.sgml
zip vlc-user-guide-pdf.zip vlc-user-guide.pdf
sgmltools -b pdf -s ../common/stylesheet-print-noicones.dsl $(DOC).sgml
zip $(DOC)-pdf.zip $(DOC).pdf
rtf:
/bin/cp ../common/magic-jpg.sgml ../common/magic.sgml
/bin/cp ../../images/plan-videolan-640.jpg .
sgmltools -b rtf -s ../common/stylesheet-print-noicones.dsl vlc-user-guide.sgml
zip vlc-user-guide-rtf.zip vlc-user-guide.rtf *.jpg
sgmltools -b rtf -s ../common/stylesheet-print-noicones.dsl $(DOC).sgml
rm -f $(DOC)-rtf.zip
zip $(DOC)-rtf.zip $(DOC).rtf images/*.jpg
txt:
sgmltools -b txt vlc-user-guide.sgml
sgmltools -b txt $(DOC).sgml
clean:
rm -f *.zip *.html *.pdf *.ps *.jpg *.txt *.rtf
rm -f *.zip *.html *.pdf *.ps *.txt *.rtf
......@@ -28,9 +28,9 @@ display MPEG streams under multiple operating systems.</li>
<p>This diagram illustrates the VideoLAN solution:</p>
<p class="center"><a href="/images/plan-videolan-800.jpg"><img
src="/images/plan-videolan-640.jpg" alt="VideoLAN Solution" /></a></p>
<p class="center">
<img src="/images/documentation/plan-videolan.jpg" alt="VideoLAN Solution" />
</p>
<p>
......@@ -149,4 +149,4 @@ download page</a>.</p></li>
</table>
<? footer('$Id: index.html,v 1.36 2003/05/05 12:55:19 alexis Exp $'); ?>
<? footer('$Id: index.html,v 1.37 2003/05/06 17:16:04 alexis Exp $'); ?>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment