diff --git a/docs/userguide/en/applications.html b/docs/userguide/en/applications.html index f068e7ded0..bbf1918c21 100644 --- a/docs/userguide/en/applications.html +++ b/docs/userguide/en/applications.html @@ -42,7 +42,9 @@

Before diving into all the applications that come with Haiku, let's have a more detailed look at how to install and uninstall programs you downloaded somewhere, for example from a site mentioned on the Welcome page.

-

Installing applications

+

+index +Installing applications

Haiku software always comes as an archive. Most of the time it's a ZIP, some old BeOS packages come in Software Valet's PKG format. Software Valet was able to automatically execute installation scripts, so after double-clicking you just select a destination folder and everything's taken care of.
If it's a ZIP archive, double-clicking opens Expander where you also set the destination and unpack it. As explained in the topic Filesystem layout, that destination is either

@@ -56,13 +58,17 @@ Sometimes you'll find folders that link to the correct destination named "Most of the time, however, nothing of the sort is necessary and you're done after unpacking.
See topic Deskbar or LaunchBox to see how to add shortcuts to your newly installed application.

-

Uninstalling applications

+

+index +Uninstalling applications

If the installation was done with an install script, chances are, there's an uninstall script as well. In that case, double-click it and you're done.
Otherwise, uninstalling is simply done by deleting the application's folder.

This, of course, leaves back possible configuration files in your ~/config/settings folder. This may be on purpose, if you want to keep those settings in case you'll install the program again in the future. Also, when the installation involved those "drag [filename] here..." folders, those files are also left behind.

One method to quickly get to all the app's files is to do a quick query for a significant part of the application's name. This will reveal the app's binary, its installation folder and its settings as well as possible links in the Deskbar etc. Simply select all relevant files and delete them.

-

Haiku's applications

+

+index +Haiku's applications

Haiku comes with a set of mostly small but essential applications. You'll find all of them at /boot/system/apps/ or /boot/common/apps/. Applications that are not usually launched by a double-click on a data file (e.g. ShowImage for image files) can be found in the Applications menu of the Deskbar.

@@ -117,7 +123,9 @@ Otherwise, uninstalling is simply done by deleting the application's folder.

iconActivityMonitor  A viewer for analog TV. [still missing]
-

Bundled applications

+

+index +Bundled applications

Besides the above listed programs, which are all maintained by the Haiku project, there are a few essential applications bundled in a standard Haiku system. Bugs and feature requests for those have to be filed with the particular maintainer.

diff --git a/docs/userguide/en/applications/apps-icon-o-matic.html b/docs/userguide/en/applications/apps-icon-o-matic.html index ba43ff282c..39e30a5ebd 100644 --- a/docs/userguide/en/applications/apps-icon-o-matic.html +++ b/docs/userguide/en/applications/apps-icon-o-matic.html @@ -63,7 +63,7 @@

Before we come to the actual creating of icons in Icon-O-Matic, a few words on Haiku's icons in general.

-index +index BeOS bitmap vs. Haiku vector icons

Contrary to the BeOS, Haiku uses vector icons instead of bitmap icons. A special Haiku Vector Icon Format (HVIF) was developed that is highly optimized for small file sizes and fast rendering. That's why our icons are for the most part much smaller than either a bitmap or the widely used SVG format. Also, unlike BeOS' bitmap icons, Haiku isn't limited to an 8bit palette (256 colors).
Take this icon of the Terminal, for example:

@@ -102,13 +102,13 @@ width="128" height="128" />
iconBePDF 

-index +index Icons are attributes

Icons are stored as an attribute with their file. However, that doesn't mean that every file has to have this attribute to appear with an icon in a Tracker window: data files inherit their icon from their filetype. To globally change the filetype's icon you use the FileTypes preferences. If you only want to add a special icon to an individual file, you use the FileType Add-On on it instead. See topic Filetypes for more information.

Being an attribute, it follows that only filesystems supporting metadata can retain a file's individual icon. So, if you move files off your BFS volume, consider zipping them up so you don't lose icons or other attributes.

-index +index Creating icons with Icon-O-Matic

Icon-O-Matic is Haiku's icon editor that can save your work as HVIF, SVG or PNG. The icon can also be directly attached as attribute to an existing file or exported as a resource or source file used by developers. Since the application was tailored to the optimized HVIF format, its usage reflects the inner workings of this format.

Other than your normal vector graphics software, you don't deal with separate objects that each include all their specific properties like path, stroke width, stroke and fill color etc. Rather, you assemble your objects ("shapes") from shared paths and colors ("styles") and set certain properties. This re-using of elements is one secret of HVIF's efficiency. Although that imposes some constraints on the icon designer, there are a few advantages, too.
@@ -121,7 +121,7 @@ For example, by re-using a path, several objects can be modified together by man

-index +index Path

A path consists of several points which are connected with lines or Bezier curves. To add or change points, make sure, the path is selected in the path list.

@@ -185,7 +185,7 @@ width="16" height="16" />

-index +index Shape

A shape groups together one or more paths with a style. Practically, it's the object that you'll actually see on the canvas. The grouping is done with the checkboxes in front of the paths and styles: Just select your shape and tick off the desired path(s) and a style.

A shape defines how a path and style is applied, e.g. if the object is filled or only stroked (which is done by using Transformers on the shape, we'll get to that later). Also, a shape can be moved, rotated or resized without touching the used path. That way, you can re-use a single path and get different, but related, shapes.

@@ -259,7 +259,7 @@ For example, if Shape 1 were to be shown below 48px and Shape 2 from 48px upward

-index +index Style

A style can either be a solid color or some type of gradient.
Besides the predefined colors under Swatches, you can mix your own by clicking on the current color. Also, note the slider under the color spectrum which sets the alpha-channel (transparency).

@@ -277,7 +277,7 @@ Of course you can move these indicators to change the gradient to your liking. Y

-index +index Transformer

A shape can have Transformers which change its appearance. The effects, however, are more subtle than a truck turning into a battle robot...

@@ -300,7 +300,7 @@ Of course you can move these indicators to change the gradient to your liking. Y

-index +index Saving an icon

There's your usual menu bar at the top, File, Edit, Options. The usage is pretty much self-explaining, so we'll only look at how to save your work.

File | Save As... will save in a special Icon-O-Matic format that retains additional information like the names of paths, shapes and styles. These will be stripped from the actual icon once you export it to save space. It's a good idea to back-up your work like this, because without named objects everything's named "<path>/<shape>/<style>" which makes specific changes tedious.

@@ -319,7 +319,7 @@ Of course you can move these indicators to change the gradient to your liking. Y

-index +index Tips & Tricks

A few things you should keep in mind when working with Icon-O-Matic and some general tips for its usage:

-index +index Creating a custom filetype

Start the Filetypes preferences, and click on the Add... button below the hierarchical list on the left. A small dialog opens and you specify in which MIME Group your new filetype will reside. You can also create a completely new group. Let's put it into "applications" and set the "Internal Name" to DVDdb.

filetypes-new-file-type.png @@ -84,17 +84,17 @@ To that we add a couple of attributes. Here we have to decide if we want to quer filetypes-dvddb.png

-index +index Icon

Double-click the icon well to open Icon-O-Matic to design an icon for your filetype. You can also drag&drop an icon from the icon well of another type, maybe as starting point for a modified version.

-index +index File Recognition

You can add suffixes like .txt, .jpg, .mp3 to recognize files by their extention. Useful when working with files from systems without MIME typing. We don't need that for our example.

-index +index Description

-index +index Preferred Application

This drop-down menu shows a list of all applications that can handle this particular filetype. From here you can choose which program should open this specific file when it's double-clicked.

@@ -111,7 +111,7 @@ To that we add a couple of attributes. Here we have to decide if we want to quer

-index +index Extra Attributes

Here we enter all the custom attributes we decided on in our preparations. Clicking the Add... button opens a panel:

filetype-extra-attribute.png @@ -152,7 +152,7 @@ To that we add a couple of attributes. Here we have to decide if we want to quer

-index +index Indexing

Before we start entering data in our little DVD database, we should add certain attributes to the Index. Only indexed attributes can use Haiku's fast Queries.
So, what will we be searching in the future? We probably won't ask "What's in the B4 coordinate in my shelf?" or "Does the IMdB URL or the plot of the movie contain the word 'pope-shenooda'?".

@@ -173,7 +173,7 @@ mkindex -t int DVDdb:rating

The -t option defines the type of attribute, which is "string" for all but the rating, which is an integer number.

-index +index Filling in the data

Now, everything's set and we can begin putting some data into our base.
Since our basic file is a cover image, we go to some online resource like IMdB, look for our first movie and save the cover or movie poster in a new folder where we want to keep our DVDdb files.

@@ -185,7 +185,7 @@ Since our basic file is a cover image, we go to some online resource like IMdB,

Right-clicking into a Tracker window, you'll find a new entry under New... besides the default "New folder".

-index +index Querying the database

Several hours of grunt work later, we have a nice little database that you can query to find all your Christina Ricci movies that have a 7+ rating... :)

You can assign a sensible attribute layout for query results of a specific filetype.
diff --git a/docs/userguide/en/workspaces.html b/docs/userguide/en/workspaces.html index eb8b148b56..e6b5543a07 100644 --- a/docs/userguide/en/workspaces.html +++ b/docs/userguide/en/workspaces.html @@ -53,16 +53,22 @@ Change Workspace Count... will open the Screen preferences where you set the number of workspaces and their arrangement (how many rows and columns).

Since the applet is a Replicant, you can resize the window as desired and then drag&drop it by its handle onto the desktop (make sure "Show Replicants" is activated in the Deskbar menu).

-

Switching workspaces

+

+index +Switching workspaces

You switch between workspaces by either clicking into the Workspaces applet or by using the keyboard shortcut ALT Fx, where "x" is the workspace number. It's a good idea to arrange your workspaces in rows of four to mimick the layout of the Fx keys on the keyboard.
Also, clicking on an application or one of its windows in the Deskbar will send you to the workspace it's in.

Another very convenient way is to use CTRL ALT /// to navigate spatially the rows/columns of the available workspaces.

You can switch back and forth between two workspaces with ALT ~ (which, depending on the keymap you're using, is the key below ESC, which you have to hit twice to get a ~).

-

Moving windows between workspaces

+

+index +Moving windows between workspaces

To move a window, you grab it in the Workspaces applet and simply drag it to another workspace. This has the advantage, that you can move it without leaving your current desktop. Of course, that only works well when there aren't too many windows in a workspace and your target isn't obscured by other windows. Another possibility is to grab a window by its tab and just holding on to it while switching workspaces with ALT Fx.

-

Special functionality

+

+index +Special functionality

The Workspaces applet provides some additional functionality when clicking on a window while holding certain modifier keys: diff --git a/docs/userguide/images/apps-images/magnify.png b/docs/userguide/images/apps-images/magnify.png deleted file mode 100644 index 83418c4abf..0000000000 Binary files a/docs/userguide/images/apps-images/magnify.png and /dev/null differ diff --git a/docs/userguide/images/up.png b/docs/userguide/images/up.png index 8b5ac7277e..290be91830 100644 Binary files a/docs/userguide/images/up.png and b/docs/userguide/images/up.png differ diff --git a/docs/welcome/images/up.png b/docs/welcome/images/up.png index 8b5ac7277e..290be91830 100644 Binary files a/docs/welcome/images/up.png and b/docs/welcome/images/up.png differ diff --git a/docs/welcome/welcome.html b/docs/welcome/welcome.html index 5be8cf9f42..512e8c354e 100644 --- a/docs/welcome/welcome.html +++ b/docs/welcome/welcome.html @@ -29,10 +29,13 @@
-

Welcome to Haiku!

+

+Welcome to Haiku!

Thank you very much for checking out Haiku! This is our first public release. We hope to attract new developers to our project and give future users a chance to check out Haiku. We realize that this alpha release does not yet fully live up to the goals that we have set for ourselves and doesn't offer all the features and well-rounded end-user experience planned for the final R1 version. However, we hope that this release lets you discover Haiku's great potential and that you share our excitement.

-

Beware of Bugs

+

+index +Beware of Bugs

We were working very hard to fix all possibly show stopping bugs, however, being an alpha release, there are bound to be plenty left undiscovered.

We discourage using alpha versions as a production system. Your data could very well be altered, mangled or downright destroyed.
@@ -42,14 +45,18 @@
  • Tips for a helpful bug report
  • -

    Getting to know the system

    +

    +index +Getting to know the system

    The first release(s) of Haiku will be very much like the BeOS R5, the operating system it is reimplementing. If you never experienced it, have a look at these links:

    -

    Installing more software

    +

    +index +Installing more software

    Because of our binary and source compatibility, many BeOS applications run on Haiku. After downloading a package, simply unzip it (double clicking opens Expander) to /boot/apps/ and start the application from there.

    An exception are OptionalPackages, which are normally included when building Haiku directly from source. Those can, however, also be downloaded and added to any running Haiku system. The only difference to normal archives: you have to unzip directly to root /.
    @@ -62,7 +69,9 @@
  • OsDrawer hosts native BeOS and Haiku open source software projects
  • -

    Getting to know the API

    +

    +index +Getting to know the API

    Since Haiku is a reimplementation, the API is still the same as for BeOS R5 (with some additions). Therefore the documentation in the BeBook is still a valid resource. Thanks to ACCESS, who own the rights to former Be Inc. property, we are allowed to provide a copy of the BeBook.

    There are additional resources that should help you getting started:

    @@ -73,7 +82,9 @@
  • BeNewsletter Archive
  • -

    Getting in contact

    +

    +index +Getting in contact

    Get in contact with other developers and users and join the discussions on IRC, in our forums or the mailing lists. When many different people come together, rules have to established to keep communication effective. Please respect our Mailing List Etiquette.

    CTRLBrings the the window to the foreground.