Skip to content

Jolicloud/ubiquity-slideshow-jolicloud

Repository files navigation

Ubuntu slideshow for Ubuntu ubiquity-slideshow-ubuntu

Slideshow to display with the Ubiquity GTK front-end for Ubuntu
<http://launchpad.net/ubiquity-slideshow-ubuntu>

-----

This project contains a slideshow focused on Ubuntu Linux. It
is to be presented while installing Ubuntu using Ubiquity. This
is associated with the ubiquity-slideshow group on Launchpad at
<https://launchpad.net/~ubiquity-slideshow>, which also owns a branch
of Ubiquity that handles displaying the slideshow.

Feedback on the project, this Readme, or anything at all is appreciated!

Please also note the "COPYING", "AUTHORS" and "TODO" files in this
directory, which all have cool stuff.

-----

Writing guidelines:

* Write in the present (no "Ubuntu will" or "Ubuntu would"). Not just
present tense, but with an awareness of what is going on around the
slideshow. We can assume the user is running a default Ubuntu session as
he installs it, and also that he has chosen to install Ubuntu willingly;
that person is now an Ubuntu user. The sales-person voice should not
exist. If you start to hear that voice, file a bug immediately.

* Avoid the car instruction manual voice where possible. That is, try not
to tell people where specific features are, but what they can expect to
find. This is because the slideshow won't follow our users everywhere,
so we have to answer a different question: "What next?" If we fixate
energy on pressing buttons, it will not stick :)

* Write from the perspective of us (people, probably) explaining
Ubuntu and free software to the immediate end user; the person behind
the screen. Think of it as enthusing with a friend about this great new
thing they have started to explore, making sure they know what they need
to know to really enjoy it.

-----

Design guidelines:

Thanks to Andrew Higginson for the wonderful new slide design which
actually looks good! With that contribution, I'm going to drop the "I have
no idea where this is going" line and say: "Make more of those slides!"
Some quick things to keep in mind...

* Refrain from using drop shadows or reflections inside the white content
area of a slide. There is already one reflected object consistently in
use (in an area that the content area does not touch); adding another
could lead to visual inconsistency.

-----

DO BE AFRAID to split a single thing across multiple slides. Please try
to keep things neat, tidy and short. In a lot of caces we can trust our
viewers to find things on their own as long as we show them where to
start, so it's possible for a single slide to do quite a bit.

-----

Quick technical information for slides:

* We have a size limit! The slideshow should fit on a screen resolution
below 800x600 along with the Ubiquity progress bar and information. Thus,
slides should be designed to the size of 700x420 pixels.

* Please use ./SlideTemplate.html to start off new slides. This way,
we will be able to maintain a standard format. Of course, if you feel
that a different template would work better, let us know. Just copy that
file into the ./slides directory and have fun.

* The slideshow is created using HTML, Javascript and CSS. The script
in index.html rotates between slides and embeds them in itself, (in the
process creating a simple transition effect). The slides are very simple,
small snippets of HTML. When loaded by index.html, slides gain the
properties of the CSS stylesheet in ./slides/link/general.css. Note that
these are SNIPPETS; they do not contain headers, body tags, or anything
of that sort and when viewed appear very plain or may not render in a web
browser at all.  Slides should contain some divisions with the following
IDs in this order: "title", "main" and "content". There should also be a
small image with the id "icon". The "content" section should contain the
written information central to the slide. In theory, you could actually
put whatever you please inside the "main" division, but "screenshots"
and "content" are highly recommended.

* The icon I mention is at the bottom right of each slide. It is a small
image, typically representing the application or action being described by
the slide. This should be the same icon the user normally sees associated
with that application. These icons are to be built automatically. For that
to function, please place an SVG source for the icon inside the
icons-source directory. When generate-pngs.sh is run, the icon will be
automatically sized and decorated. The resulting icon is placed in
.slides/icons with the same name as your SVG source except with .png at
the end instead of .svg.
When adding new icons, please be sure to update debian/copyright with the
license details.

* To view your slide (or the slideshow) in its full glory, you will
need to edit ./slides/index.html. Add your slide to the list inside its
"container" section, then open that file in a web browser. In the browser,
you can throw #controls at the end to get a Back and Forward button.
You can also run ./Slideshow.py to get a preview running in Webkit.