Skip to content

Commit

Permalink
Indexing preface chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
kthakore committed Jul 25, 2011
1 parent 90590f3 commit c988b63
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
22 changes: 22 additions & 0 deletions dist/SDL_Manual.html
@@ -1,22 +1,30 @@
<h1>Preface</h1>

<p><a name="libsdl"> </p>

<p><i>Simple DirectMedia Layer</i> (or <i>libsdl</i>) is a cross-platform C
library that provides access to several input and output devices. Its most
popular usage is to provide access to the video framebuffer and input
devices for games. SDL also has several extension libraries to provide
features such as text display, sound mixing, image handling, and graphics
effects.</p>

<p> </p>

<p>SDL Perl binds several of these libraries together in the
<code>SDL::*</code> namespace. Moreover, SDL Perl provides several
high-level libraries in the <code>SDLx::*</code> namespace that encapsulate
valuable game-writing abstractions.</p>

<p></p>

<h2><code>SDL</code> and <code>SDLx</code></h2>

<p>The main purpose of the <code>SDLx::*</code> layer is to smooth out the
drudgery of using the <code>SDL::*</code> layer directly.</p>

<p></p>

<blockquote>

<p>Don't worry about understanding the details of this code right now.
Expand Down Expand Up @@ -98,17 +106,23 @@ <h2>About the Book</h2>

<h2>Installing SDL Perl</h2>

<p></p>

<p>We assume the presence of a recent version of the Perl language (at
least Perl 5.10) and supporting packages. We also assume that you can
install packages from the CPAN, including SDL Perl itself.</p>

<h3>Windows</h3>

<p> </p>

<p><code>Alien::SDL</code> will install binaries for 32bit and 64bit so
there is no need to compile anything.</p>

<h3>Mac OS X</h3>

<p> </p>

<p>Fink has packages for SDL Perl available. However, they do not support
Pango, a library which provides internalization support for text
handling.</p>
Expand All @@ -121,6 +135,8 @@ <h3>Mac OS X</h3>

<h3>GNU/Linux</h3>

<p> </p>

<p>Most current GNU/Linux distributions include all the parts needed for
this tutorial in the default install and in their package management
system. It is also always possible to install on GNU/Linux using the
Expand All @@ -144,6 +160,8 @@ <h3>GNU/Linux</h3>

<h3>CPAN install</h3>

<p></p>

<p>Before installing SDL Perl, ensure that you have the most recent
versions of the modules necessary to build SDL:</p>

Expand All @@ -159,6 +177,8 @@ <h3>CPAN install</h3>

<h2>Contact</h2>

<p></p>

<p>Hopefully this book answers most of your questions. For additional
assistance, contact the project via:</p>

Expand All @@ -177,6 +197,8 @@ <h2>Contact</h2>

<h2>Examples</h2>

<p></p>

<p>The code examples in this book are available from
https://github.com/PerlGameDev/SDL_Manual/tree/master/code_listings.</p>

Expand Down
Binary file modified dist/SDL_Manual.pdf
Binary file not shown.
28 changes: 28 additions & 0 deletions src/00-preface.pod
@@ -1,20 +1,31 @@
=head0 Preface

Z<libsdl>
X<libsdl>

I<Simple DirectMedia Layer> (or I<libsdl>) is a cross-platform C library that
provides access to several input and output devices. Its most popular usage is
to provide access to the video framebuffer and input devices for games. SDL
also has several extension libraries to provide features such as text display,
sound mixing, image handling, and graphics effects.

X<Description libsdl>
X<libsdl Description>

SDL Perl binds several of these libraries together in the C<SDL::*> namespace.
Moreover, SDL Perl provides several high-level libraries in the C<SDLx::*>
namespace that encapsulate valuable game-writing abstractions.

X< C<SDL::> and C<SDLx::> namespace>


=head1 C<SDL> and C<SDLx>

The main purpose of the C<SDLx::*> layer is to smooth out the drudgery of using
the C<SDL::*> layer directly.

X< C<SDL::> and C<SDLx::> purpose>

=for sidebar

Don't worry about understanding the details of this code right now. Compare the
Expand Down Expand Up @@ -100,17 +111,25 @@ U<http://sdl.perl.org/>.

=head1 Installing SDL Perl

X<Installing>

We assume the presence of a recent version of the Perl language (at least Perl
5.10) and supporting packages. We also assume that you can install packages
from the CPAN, including SDL Perl itself.

=head2 Windows

X<Installing Windows>
X<Windows: Install>

C<Alien::SDL> will install binaries for 32bit and 64bit so there is no need
to compile anything.

=head2 Mac OS X

X<Installing Mac OS X>
X<Mac OS X: Install>

Fink has packages for SDL Perl available. However, they do not support Pango, a
library which provides internalization support for text handling.

Expand All @@ -121,6 +140,9 @@ their headers.

=head2 GNU/Linux

X<Installing Linux>
X<Linux: Install>

Most current GNU/Linux distributions include all the parts needed for this
tutorial in the default install and in their package management system. It is
also always possible to install on GNU/Linux using the available open source
Expand All @@ -142,6 +164,8 @@ and some libraries are required.

=head2 CPAN install

X<SDL install>

Before installing SDL Perl, ensure that you have the most recent versions of
the modules necessary to build SDL:

Expand All @@ -157,6 +181,8 @@ platforms are listed at U<http://pass.cpantesters.org/distro/S/SDL.html>.

=head1 Contact

X<Contact>

Hopefully this book answers most of your questions. For additional assistance,
contact the project via:

Expand All @@ -174,6 +200,8 @@ active and helpful resource.

=head1 Examples

X<Code Examples>

The code examples in this book are available from
U<https://github.com/PerlGameDev/SDL_Manual/tree/master/code_listings>.

Expand Down

0 comments on commit c988b63

Please sign in to comment.