Haiku/userguide
1
0
Fork 0
mirror of https://review.haiku-os.org/userguide synced 2024-11-23 07:08:25 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

* Added more "up-to-top-of-page" symbol/links to h1/h2 headings where appropriate

Browse Source 
* Changed "up-to-top-of-page" symbol to a 90° rotated bullet graphic of the new
  website (Good idea, Jorge.). Increased its size to 32x32 so it's easier to
  aim for.
* Mentioned new ~/config/boot/launch/ folder in filesystem-layout.html.
* Updated Workspaces screenshot due to renamed options (Thanks Ryan.)
* Moved magnify.png to the /en/images/apps-images/ subfolder as it's not totally
  language neutral.



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32754 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Joachim Seemer 2009-08-27 14:17:18 +00:00
parent 177443a2eb
commit 40293bd033
28 changed files with 218 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
userguide/en/applications.html
View File

@ -42,7 +42,9 @@
<p>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 <a href="../../welcome/welcome.html#software">Welcome</a> page.
</p>
<h1><a id="install" name="install">Installing applications</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="install" name="install">Installing applications</a></h1>
<p>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.<br />
If it's a ZIP archive, double-clicking opens <span class="app">Expander</span> where you also set the destination and unpack it. As explained in the topic <a href="filesystem-layout.html">Filesystem layout</a>, that destination is either</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
@ -56,13 +58,17 @@ Sometimes you'll find folders that link to the correct destination named "<span
<p>Most of the time, however, nothing of the sort is necessary and you're done after unpacking.<br />
See topic <a href="deskbar.html">Deskbar</a> or <a href="desktop-applets/desktop-applets-launchbox.html">LaunchBox</a> to see how to add shortcuts to your newly installed application.</p>
<h1><a id="uninstall" name="uninstall">Uninstalling applications</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="uninstall" name="uninstall">Uninstalling applications</a></h1>
<p>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.<br />
Otherwise, uninstalling is simply done by deleting the application's folder.</p>
<p>This, of course, leaves back possible configuration files in your <span class="path">~/config/settings</span> 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 "<span class="cli">drag [filename] here...</span>" folders, those files are also left behind.</p>
<p>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.</p>
<h1><a id="list-of-apps" name="list-of-apps">Haiku's applications</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="list-of-apps" name="list-of-apps">Haiku's applications</a></h1>
<p>Haiku comes with a set of mostly small but essential applications. You'll find all of them at <span class="path">/boot/system/apps/</span> or <span class="path">/boot/common/apps/</span>. 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 <span class="menu">Applications</span> menu of the Deskbar.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td style="width:24px;"><img src="../images/apps-images/activitymonitor-icon_16.png" alt="icon" width="16" height="16" /></td><td><a href="applications/apps-activitymonitor.html">ActivityMonitor</a></td><td style="width:10px;">&#160;</td>
@ -117,7 +123,9 @@ Otherwise, uninstalling is simply done by deleting the application's folder.</p>
<td valign="top"><span style="color:silver">A viewer for analog TV. [<i>still missing</i>]</span></td></tr>
</table>
<h1><a id="list-of-bundled-apps" name="list-of-bundled-apps">Bundled applications</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="list-of-bundled-apps" name="list-of-bundled-apps">Bundled applications</a></h1>
<p>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.</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td style="width:24px;"><img src="../images/apps-images/bepdf-icon_16.png" alt="icon" width="16" height="16" /></td><td><a href="applications/apps-bepdf.html">BePDF</a></td><td>&#160;</td>

20
userguide/en/applications/apps-icon-o-matic.html
View File

@ -63,7 +63,7 @@
<p>Before we come to the actual creating of icons in Icon-O-Matic, a few words on Haiku's icons in general.</p>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="bitmap-vector" name="bitmap-vector">BeOS bitmap vs. Haiku vector icons</a></h1>
<p>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 <i>much</i> 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).<br />
Take this icon of the Terminal, for example:</p>
@ -102,13 +102,13 @@ width="128" height="128" /></td>
</table>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="icons-attributes" name="icons-attributes">Icons are attributes</a></h1>
<p>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 <span class="app">FileTypes</span> preferences. If you only want to add a special icon to an individual file, you use the <span class="app">FileType Add-On</span> on it instead. See topic <a href="../filetypes.html">Filetypes</a> for more information.</p>
<div class="box-info">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.</div>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="i-o-m" name="i-o-m">Creating icons with Icon-O-Matic</a></h1>
<p>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.</p>
<p>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.<br />
@ -121,7 +121,7 @@ For example, by re-using a path, several objects can be modified together by man
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="i-o-m-path" name="i-o-m-path">Path</a></h2>
<p>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.</p>
@ -185,7 +185,7 @@ width="16" height="16" /></td>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="i-o-m-shape" name="i-o-m-shape">Shape</a></h2>
<p>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.</p>
<p>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.</p>
@ -259,7 +259,7 @@ For example, if Shape 1 were to be shown below 48px and Shape 2 from 48px upward
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="i-o-m-style" name="i-o-m-style">Style</a></h2>
<p>A style can either be a solid color or some type of gradient.<br />
Besides the predefined colors under <span class="menu">Swatches</span>, 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).</p>
@ -277,7 +277,7 @@ Of course you can move these indicators to change the gradient to your liking. Y
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="i-o-m-transformer" name="i-o-m-transformer">Transformer</a></h2>
<p>A shape can have Transformers which change its appearance. The effects, however, are more subtle than a truck turning into a battle robot...</p>
@ -300,7 +300,7 @@ Of course you can move these indicators to change the gradient to your liking. Y
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="i-o-m-save" name="i-o-m-save">Saving an icon</a></h2>
<p>There's your usual menu bar at the top, <span class="menu">File</span>, <span class="menu">Edit</span>, <span class="menu">Options</span>. The usage is pretty much self-explaining, so we'll only look at how to save your work.</p>
<p><span class="menu">File | Save As...</span> 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 "&lt;path&gt;/&lt;shape&gt;/&lt;style&gt;" which makes specific changes tedious.</p>
@ -319,7 +319,7 @@ Of course you can move these indicators to change the gradient to your liking. Y
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="i-o-m-tips" name="i-o-m-tips">Tips & Tricks</a></h2>
<p>A few things you should keep in mind when working with Icon-O-Matic and some general tips for its usage:</p>
<ul>
@ -335,7 +335,7 @@ Of course you can move these indicators to change the gradient to your liking. Y
<!--
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="i-o-m-workshops" name="i-o-m-workshops">Workshops</a></h2>
<p>The above is of course quite theoretical. The best way to learn using Icon-O-Matic is by experimenting. To get you started and once more show the basics, have a look at these short clips:</p>
<ul>

4
userguide/en/applications/apps-screenshot.html
View File

@ -51,7 +51,9 @@ width="64" height="64" />Screenshot</h1>
<p><img id="sreenshot-options" src="../images/apps-images/screenshot-options.png" alt="screenshot-options.png" /></p>
<p>Besides the obvious, toggle between taking the whole screen or just the active window, including the window border and the mouse pointer, you can enter a delay before a screenshot is taken. Of course, this delay takes only effect if you take a new shot by pressing <span class="button">Take Screenshot</span>.</p>
<h1>Taking a screenshot from Terminal</h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
Taking a screenshot from Terminal</h1>
<p>The Screenshot application is also usable from Terminal or a script.<br />
<span class="cli">Screenshot --help</span> shows the familiar options as parameters:</p>

16
userguide/en/applications/apps-terminal.html
View File

@ -48,7 +48,9 @@
<p>The Terminal is Haiku's interface to bash, the Bourne Again Shell.</p>
<p>Please refer to the topic on <a href="../bash-scripting.html">Scripting</a> for a few links to online tutorials on working in the shell. Here, we'll concentrate on the Terminal application itself.</p>
<h2><a id="appearance" name="appearance">Appearance</a></h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="appearance" name="appearance">Appearance</a></h2>
<p>You can open as many Terminals as needed, either each in it's own window by simply launching more Terminals or with <span class="key">ALT</span>&#160;<span class="key">N</span> from an already running Terminal. Or you use Terminal's tabbed view and open another tab with <span class="key">ALT</span>&#160;<span class="key">T</span>.</p>
<p>A Terminal window can be resized like any other window or you use the presets from the <span class="menu">Settings | Window Size</span> menu. <span class="key">ALT</span>&#160;<span class="key">ENTER</span> toggles fullscreen mode.</p>
<p>Changed window size and text encoding are only kept choosing <span class="menu">Settings | Save as default</span>.</p>
@ -57,7 +59,9 @@
<p><span class="menu">Settings | Preferences</span> opens a panel where you can set font type, font size and the different text and background colors. You can save different settings as separate profiles, which on double-click open an accordingly configured Terminal.<br />
Pressing <span class="button">OK</span> will save the current settings as default.</p>
<h2><a id="customization" name="customization">Bash customization</a></h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="customization" name="customization">Bash customization</a></h2>
<p>Coming from Unix, there are countless possibilities to customize the bash itself. There are two files that are especially important to the user: <span class="cli">.profile</span> and <span class="cli">.inputrc</span><br />
Both files can be created in the <span class="path">home/</span> folder and add or override the system defaults that are defined in <span class="path">/boot/system/etc/</span>.</p>
@ -75,10 +79,14 @@ Both files can be created in the <span class="path">home/</span> folder and add
<h3>.inputrc</h3>
<p>The <span class="cli">.inputrc</span> deals with keybindings. Since Haiku provides useful defaults, you probably don't have to mess with these more involved settings. If you do have special needs here, consult one of the many online resources, e.g. <a href="http://tiswww.case.edu/php/chet/readline/rluserman.html">The GNU Readline Library</a>.</p>
<h2><a id="shortcuts" name="shortcuts">Keyboard shortcuts</a></h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="shortcuts" name="shortcuts">Keyboard shortcuts</a></h2>
<p>You'll find a list of useful shortcuts in <a href="../keyboard-shortcuts.html#terminal">Shortcuts and key combinations</a>.</p>
<h2><a id="hints" name="hints">Hints for working with the Terminal</a></h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="hints" name="hints">Hints for working with the Terminal</a></h2>
<ul><li><p>Dragging a file or folder from a Tracker window into the Terminal will insert its path at the location of the cursor. Dragging with the right mouse button offers additional actions in a context menu:</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><span class="menu">Insert Path</span></td><td>&#160;</td><td>Inserts the location of the file, same as drag&dropping with the left mouse button.</td></tr>

8
userguide/en/attributes.html
View File

@ -46,14 +46,18 @@
<p>As you can see, these are all 0-sized files with attached attributes, the E-mail attribute of "John Nox" being edited right in Tracker.</p>
<p>If you index these attributes, as People, Email or audio files are by default, they are also searchable with Haiku's fast query system.</p>
<h1><a id="attributes-tracker" name="attributes-tracker">Attributes in Tracker</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="attributes-tracker" name="attributes-tracker">Attributes in Tracker</a></h1>
<p>Attributes are displayed quite similar to a database or spreadsheet. Using Tracker you can choose which attributes to display (columns) and sort file listings (rows) accordingly.</p>
<p>To do this, open a Tracker window, click on the <span class="menu">Attributes</span> menu, and select the attributes you want to display. Alternatively, simply right-click onto a column heading and mark the items in the context menu. You can rearrange the columns by a simple drag&amp;drop of the column heading. Moving a column out of a window, is a fast way to get rid of columns you don't need.</p>
<p>Double-click on the line between two attributes in the heading to automatically resize a column to its optimal width.</p>
<p>Click on a column heading to toggle the sorting order from ascending to descending. You can establish a secondary sort order by pressing the <span class="key">SHIFT</span> key while clicking on a column heading. Doing that you can, for example, sort your People files by company and within that order sort by contact name. See the above screenshot as an example. The secondary sort order is marked by a lighter colored indicator beside the heading.</p>
<p>Editing these attributes is as simple as renaming a file: Either click on an entry or press <span class="key">ALT</span>&#160;<span class="key">E</span> and move between the attributes with <span class="key">TAB</span> and <span class="key">SHIFT</span>&#160;<span class="key">TAB</span>. <span class="key">ESC</span> leaves the editing mode without applying the changes.</p>
<h1><a id="attributes-terminal" name="attributes-terminal">Attributes in Terminal</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="attributes-terminal" name="attributes-terminal">Attributes in Terminal</a></h1>
<p>If you prefer to use the commandline or plan to work with many files using scripting, there are several commands for controlling attributes from Terminal:</p>
<ul><li><b>listattr</b> - lists a file's attributes, but doesn't show the contents of the attributes.<br />
<pre>usage: listattr 'filename' ['filename' ...]</pre>

23
userguide/en/bash-scripting.html
View File

@ -41,17 +41,24 @@
<p>"Scripting" is the technique of automating procedures by stringing together commands and saving it all as text files, so called "scripts". Every time you run such a script, the commands are processed one after the other just like they would if you entered them into the <a href="applications/apps-terminal.html">Terminal</a> by hand.<br />
Scripts can range from simply executing a few commands in a specific order to sophisticated pieces of code that solve complex tasks.</p>
<h1><a id="bash" name="bash">The Bash</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="bash" name="bash">The Bash</a></h1>
<p>Since scripts rely naturally a lot on the shell they are interpreted by, you should first familiarize yourself with the BASH that's used by Haiku. There are many resources online as it's a widely used shell. One nice document is Johan Jansson's <a href="http://www.beforever.com/bashtut.htm" class="printurl">Introduction to bash - a tutorial for bash under BeOS</a>.</p>
<h1><a id="scripting-bible" name="scripting-bible">The Scripting Bible</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="scripting-bible" name="scripting-bible">The Scripting Bible</a></h1>
<p>After you've learned a few basics about working in the shell, it's time to slowly ease yourself into the world of scripting. Again, you'll find loads of tutorials and reference material online as well as in bookstores. A very nice introduction that's practically tailor-made for Haiku is the online available <a href="http://www.birdhouse.org/beos/bible/bos/ch_scripting1.html" class="printurl">Scripting Chapter</a> (<a href="http://www.birdhouse.org/beos/bible/bos/BeOS.scripting.PDF">PDF, 900kb</a>) of Scot Hacker's BeOS Bible.</p>
<h1><a id="user-scripts" name="user-scripts">Scripts in Haiku</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a><a id="user-scripts" name="user-scripts">Scripts in Haiku</a></h1>
<p>In Haiku, the system makes of course also use of scripting. Booting and shutting down are typical scripting procedures. These defined sequences can be augmented by the user with certain user scripts.<br />
If they don't exist already, you'll have to create the needed files yourself. Otherwise simply add your commands where in the process you want them to be executed.</p>
<h2><a id="userbootscript" name="userbootscript">The UserBootscript</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="userbootscript" name="userbootscript">The UserBootscript</a></h2>
<p><span class="path">/boot/home/config/boot/UserBootscript</span> will be executed after the system has finished its boot process. For example, you could launch a number of programs that would then be automatically started on every boot up:</p>
<pre># Start LaunchBox
/boot/system/apps/LaunchBox &amp;
@ -62,10 +69,14 @@ If they don't exist already, you'll have to create the needed files yourself. Ot
<p>A simple alternative to the above for launching applications at boot up is to put links to them in the <span class="path">/boot/home/config/boot/launch</span> directory. This can be done simply by right-clicking on the application you wish to have started automatically, going to <span class="menu">Create Link</span> and then <a href="tracker.html#navigating">navigating</a> to the above directory.</p>
<h2><a id="usershutdownscript" name="usershutdownscript">The UserShutdownScript</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="usershutdownscript" name="usershutdownscript">The UserShutdownScript</a></h2>
<p><span class="path">/boot/home/config/boot/UserShutdownScript</span> will be executed as the first step in the shutdown process. If the script returns a non-zero exit status, the shutdown is aborted.</p>
<h2><a id="usershutdownfinishscript" name="usershutdownfinishscript">The UserShutdownFinishScript</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="usershutdownfinishscript" name="usershutdownfinishscript">The UserShutdownFinishScript</a></h2>
<p><span class="path">/boot/home/config/boot/UserShutdownFinishScript</span> is executed as the last step in the shutdown process. Note, that most parts of the system have terminated by the time this script is executed.</p>

10
userguide/en/deskbar.html
View File

@ -52,7 +52,7 @@
<p>You can move the Deskbar to any corner or as a bar along the upper or lower border of the screen by gripping the knobbly area on the left side of the tray and drag&amp;drop it into the new position. You can also fold it into a more compact layout by drag&amp;dropping the knobbly area onto the Deskbar menu.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="deskbar-menu" name="deskbar-menu">The Deskbar Menu</a></h1>
<p>A menu opens when you click on the Deskbar's top:</p>
<img src="images/deskbar-images/settings.png" alt="settings.png" />
@ -81,7 +81,9 @@
<li><p><b>Applications, Demos, Deskbar Applets, Preferences</b> - List of installed applications, demos, applets and preferences (see <span class="menu">Configure Deskbar Menu...</span> below).</p></li>
</ul>
<h2>Configure Deskbar Menu...</h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
Configure Deskbar Menu...</h2>
<img src="images/deskbar-images/configure.png" alt="configure.png" />
<p>In this panel you set the number of recent documents, folders and applications that are shown in the Deskbar, or if you show them at all.</p>
<p>Here, you also configure folders and their contents, which are by default Applications, Demos, Deskbar Applets, and Preferences. You can add your own entries and edit or remove items.<br />
@ -89,7 +91,7 @@ This part of the panel is just a representation of the folder <span class="path"
<p>It's even easier to simply drag a file, folder or saved query and drop it where you want it into the Deskbar.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="tray" name="tray">The Tray</a></h1>
<img src="images/deskbar-images/calendar.png" alt="calendar.png" />
<p>Among other things, the tray is housing the clock. Left-click it to toggle between date and time. Right-click it to hide/show it or launch the <a href="prefs-time.html">Time</a> preferences to set it.<br />
@ -97,7 +99,7 @@ Here you can also launch a calendar that also appears, when you hold down the le
<p>Any program can install an icon in the tray to provide an interface to the user. The email system, for instance, shows a different symbol when there's unread mail and offers a context menu to e.g. create or check for new mail. <span class="app">ProcessController</span> is another example that uses its icon in the tray to provide information (CPU/memory usage) and to offer a context menu.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="list-of-apps" name="list-of-apps">The list of running programs</a></h1>
<img src="images/deskbar-images/list-of-apps.png" alt="list-of-apps.png" />
<p>You can change to a specific running application by clicking on its entry in the Deskbar and choosing (one of) its windows, from the submenu. By right-clicking you can minimize or close a window or the entire application.</p>

17
userguide/en/filesystem-layout.html
View File

@ -49,7 +49,9 @@
<tr><td><span class="path">/boot/home/</span></td><td>&#160;</td><td>is your personal folder where you keep your data and settings.</td></tr>
</table>
<h1><a id="system" name="system">The system folder - <span class="path">/boot/system/</span></a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="system" name="system">The system folder - <span class="path">/boot/system/</span></a></h1>
<p>Under Haiku's predecessor BeOS, this folder was named <span class="path">/boot/beos/</span>. You may still find it in some older documentation (e.g. in the original BeBook).<br />
Whatever it's named, you should not alter what's inside. Every update of Haiku can add, remove or overwrite anything within it. If you want to add functionality, maybe with other Tracker Add-Ons or Translators or maybe another hardware driver, you install these things under your own <span class="path">/boot/home/</span> hierarchy or, if it's supposed to be for every user, under <span class="path">/boot/common/</span>. As long as Haiku isn't multi-user, this distinction has no apparent effect, as there's only one user with one <i>home</i> folder. But since there will be support for more users than one eventually, it makes sense to learn the right way from the start.</p>
<p>So, let's say you want to install a new Translator for the latest image format, you <b>don't</b> simply copy it into the respective system folder. Remember: Don't touch!<br />
@ -71,10 +73,14 @@ If you do want to know more about how things tick in Haiku, have a look at this
-->
</p>
<h1><a id="common" name="common">The common folder - <span class="path">/boot/common/</span></a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="common" name="common">The common folder - <span class="path">/boot/common/</span></a></h1>
<p>Haiku is not a multi-user system yet. Once it is though, every user has her own <i>home</i> folder that is not accessible to anyone else. Every application or added component like Tracker Add-Ons, Translators etc. as well as any data that's supposed to be shared between different users, go here.</p>
<h1><a id="home" name="home">The home folder - <span class="path">/boot/home/</span></a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="home" name="home">The home folder - <span class="path">/boot/home/</span></a></h1>
<p>This folder belongs to you. Here you can create and delete files and folders as you wish. However, you shouldn't mess too much with the <span class="path">~/config/</span> directory and its subfolders. You <i>could</i> delete e.g. the <span class="path">~/config/settings/</span> folder without damaging the operating system itself, but who wants to lose all his configurations and application settings? In any case, the system warns you with the at the top mentioned alert.</p>
<p>Besides the <span class="path">~/config/add-ons/</span> folder, which mirrors the system's add-ons folder for additional components as described above, there are a few other folders of interest. (By the way, the tilde ("<tt>~</tt>") is a shortcut for your home folder, so you don't always have to write "<span class="path">/boot/home/</span>" in Terminal.)</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="4">
@ -91,7 +97,10 @@ If you do want to know more about how things tick in Haiku, have a look at this
<td>Complements the system's <span class="path">/boot/system/bin/</span> folder and holds all your command line programs.</td></tr>
<tr><td><span class="path">~/config/boot/</span></td><td>&#160;</td>
<td>This folder is the place for <a href="scripting.html#user-scripts">User Scripts</a> that are executed before or after the system boots up or shuts down.</td></tr>
<td>This folder is the place for <a href="bash-scripting.html#user-scripts">User Scripts</a> that are executed before or after the system boots up or shuts down.</td></tr>
<tr><td><span class="path">~/config/boot/launch/</span></td><td>&#160;</td>
<td>Links to programs or documents in this folder are automatically launched on every boot-up.</td></tr>
<tr><td><span class="path">~/config/fonts/</span></td><td>&#160;</td>
<td>Simply copy a TrueType or Postscript font into this folder and its usable right away.</td></tr>

23
userguide/en/filetypes.html
View File

@ -41,26 +41,35 @@
<p>Other than Windows, Haiku doesn't rely on the 3-letter file extension for a file type (e.g. .txt, .jpg, .mp3). This method is only a last resort fallback. Haiku uses <acronym title="Multipurpose Internet Mail Extensions">MIME</acronym> types just like it's custom on the internet.</p>
<div class="box-info">While there's no reason to use file extensions in Haiku, remember to add them to files you want to share with users of other operating systems, e.g. over email, uploading to a server or via exchange of an USB drive. Otherwise their system may not recognize the file type.</div>
<h1><a id="specific-file" name="specific-file">Setting the filetype of a specific file</a></h1>
<h1><a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="specific-file" name="specific-file">Setting the filetype of a specific file</a></h1>
<p>You can change the type of a specific file, its icon and the associated application. Select the file and invoke the <span class="menu">Add-Ons | Filetype add-on</span> from the right-click context menu.</p>
<img src="images/filetypes-images/filetype-addon.png" alt="filetype-addon.png" />
<h2><a name="filetype">The File Type</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a name="filetype">The File Type</a></h2>
<p>This is a JPEG file, it's MIME string image/jpeg. Let's say you definitely know that it's not a JPEG but a GIF. You can change that either by entering the correct MIME string by hand or with one of the two buttons below the textbox:</p>
<table summary="layout" border="0" cellpadding="2" cellspacing="0">
<tr><td><span class="button">Select...</span></td><td>&#160;</td><td>shows a hierarchical list of filetypes where you navigate to <tt>image | GIF Image</tt>.</td></tr>
<tr><td><span class="button">Same as...</span></td><td>&#160;</td><td>opens a file dialog where you choose any file that already has the filetype you're looking for.</td></tr>
</table>
<h2><a id="preferred-app" name="preferred-app">The Preferred Application</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="preferred-app" name="preferred-app">The Preferred Application</a></h2>
<p>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. You could, for example, change a HTML file's preferred application from the browser to a text editor while you're working on it. Every other HTML file still opens in the browser, only this particular one starts in your text editor.</p>
<p>The <span class="menu">Default Application</span> is the one that's set globally for that filetype. If you don't find the program you want to associate with this file in the drop-down menu, you'll again find the buttons <span class="button">Select...</span> and <span class="button">Same As...</span> which do the similar thing described under "The File Type" above.</p>
<h2><a id="icon" name="icon">The Icon</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="icon" name="icon">The Icon</a></h2>
<p>If you're wondering why the icon well on the top right is empty: Icons are normally inherited from the system default for that filetype. You can open the <span class="app">Filetype Add-On</span> of a file that contains an icon and drag&amp;drop it into your file's icon well. Or you double-click the icon well and create or edit your own icon. For more info on icons and how to create your own, see topic <a href="applications/apps-icon-o-matic.html">Icon-O-Matic</a>.</p>
<h1><a id="settings-apps" name="settings-apps">Special settings for applications</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="settings-apps" name="settings-apps">Special settings for applications</a></h1>
<p>If you invoke the <span class="app">Filetype Add-On</span> on an executable (here: <span class="app">StyledEdit</span>), you'll get a different dialog:</p>
<img src="images/filetypes-images/filetype-addon-stylededit.png" alt="filetype-addon-stylededit.png" />
<p>On top, you'll see, instead of a standardized MIME string, the unique application signature. With it, the system finds the program wherever it's installed.</p>
@ -75,7 +84,9 @@
<p>Then there's the list of supported filetypes. You can add (and remove) filetypes if you think the application can handle them. As a consequence, the app will appear in the menu for preferred applications or Tracker's <span class="menu">Open with...</span> context menu when you right-click on a file of that type.</p>
<p>At the bottom are version and copyright information. Like the application signature, they are filled in by the app's author and shouldn't be altered.</p>
<h1><a id="filetypes-preferences" name="filetypes-preferences">Global settings with the Filetypes Preferences</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="filetypes-preferences" name="filetypes-preferences">Global settings with the Filetypes Preferences</a></h1>
<p>The <span class="app">Filetypes</span> preferences don't deal with individual files but with global settings of filetypes. You can change default icons and preferred applications or add, remove, or alter attributes of whole filetypes. You can even create your own filetype from scratch.</p>
<p>All filetypes and their configurations are stored in <span class="path">/boot/home/config/settings/beos_mime/</span>. Before you start experimenting, it may be prudent to make a backup of that folder...</p>
<p>To learn more about the <span class="app">Filetypes</span> preferences see the workshop: <a href="workshop-filetypes+attributes.html">Filetypes, Attributes, Index and Queries</a>.</p>

12
userguide/en/gui.html
View File

@ -54,14 +54,18 @@
</ol>
<div class="box-info">While holding <span class="key">CTRL</span>&#160;<span class="key">ALT</span>, you can click anywhere into a window to move it with the left mouse button; the right mouse button sends it to the back.</div>
<h1><a id="open-save-panel" name="open-save-panel">Open and save panels</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="open-save-panel" name="open-save-panel">Open and save panels</a></h1>
<p>When opening or saving a file from any application, a panel like this opens:</p>
<img src="images/gui-images/open-save.png" alt="open-save.png" />
<p>It has all the usual things: A list of files of the current folder to choose from, in case of a save panel, a text field to enter a filename and a drop-down menu for different file formats and their settings.<br />
You can enter parent folders with the drop-down menu above the file listing.</p>
<p>If you already have a Tracker window with the location for a file open, you can simply drag either any file or the folder-representation (i.e. the symbol to the far right in its menu bar) into the panel. This changes the panel to that new location.</p>
<h2><a id="open-save-shortcuts" name="open-save-shortcuts">Keyboard shortcuts</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="open-save-shortcuts" name="open-save-shortcuts">Keyboard shortcuts</a></h2>
<p>You can use many of the shortcuts also used in Tracker. Besides the commands that are also available through the <span class="menu">File</span> menu, there are a few not that obvious:</p>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="2">
<tr><td><span class="key">ALT</span>&#160;<span class="key">N</span></td><td></td><td> Creates a new folder.</td></tr>
@ -72,7 +76,9 @@ You can enter parent folders with the drop-down menu above the file listing.</p>
<tr><td><span class="key">ALT</span>&#160;<span class="key">H</span></td><td></td><td> Takes you to your Home folder.</td></tr>
</table>
<h2><a id="favorites-recent" name="favorites-recent">Favorites and recent folders</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="favorites-recent" name="favorites-recent">Favorites and recent folders</a></h2>
<p>The menu <span class="menu">Favorites</span> provides recently visited folders and favorite locations that you can set up yourself. As indicated by the little arrow, you can also use these locations to navigate further down the hierarchy via submenus.</p>
<img src="images/gui-images/favorites.png" alt="favorites.png" />
<p>To add a Favorite, you simply navigate to your destination and choose <span class="menu">Favorites | Add Current Folder</span>. From now on it will appear in every open/save panel. To remove a Favorite, choose <span class="menu">Favorites | Configure Favorites...</span> and delete its entry.<br />

BIN
userguide/en/images/apps-images/magnify.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.3 KiB

BIN
userguide/en/images/workspaces-images/workspaces.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.0 KiB

After

Width:  |  Height:  |  Size: 13 KiB

3
userguide/en/index.html
View File

@ -41,7 +41,8 @@
<p><a href="attributes.html">Attributes</a> and <a href="queries.html">Queries</a> are key features of Haiku. While attributes are useful on their own, to display additional information on a file, for a query on them, they need to be indexed. It puts them into a lookup table, which in turn makes queries lightning fast.<br />
The index is part of the filesystem and is kept for every volume/partition separately.</p>
<h1>Indexing commands in Terminal</h1>
<h1>
Indexing commands in Terminal</h1>
<p>There are several commands to manage the index:</p>
<ul>
<li><b>lsindex</b> - Displays the indexed attributes on the current volume/partition.

16
userguide/en/keyboard-shortcuts.html
View File

@ -42,7 +42,9 @@
<p>In any case, you can switch to the maybe more familiar <span class="key">CTRL</span> key in the <a href="preferences/prefs-keymap.html">Keymap</a> preferences. The user guide will always describes the default configuration with the command key being <span class="key">ALT</span>.</p>
<p>If you're in doubt which keys are the <span class="key">OPT</span> or <span class="key">MENU</span> keys on your particular keymap/keyboard-layout, again use the <a href="preferences/prefs-keymap.html">Keymap</a> preferences. There you can see what keystroke is sent when you press a key on your keyboard.</p>
<h1><a id="general" name="general">General shortcuts</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="general" name="general">General shortcuts</a></h1>
<p>Here's a table of many of the most commonly used shortcuts that are always available, even if there isn't a corresponding menu:</p>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="4">
<tr><td><span class="key">ALT</span>&#160;<span class="key">Fx</span></td><td style="width:15px;"></td><td>Switches to <a href="workspaces.html">Workspace</a> X (<span class="key">Fx</span> is the function key corresponding to that workspace).</td></tr>
@ -59,7 +61,9 @@
<tr><td><span class="key">ALT</span>&#160;<span class="key">Q</span></td><td></td><td>Quits an application.</td></tr>
</table>
<h1><a id="tracker-navigation" name="tracker-navigation">Shortcuts for Tracker navigation</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="tracker-navigation" name="tracker-navigation">Shortcuts for Tracker navigation</a></h1>
<p>Additionally to the general shortcuts, here are some more for navigating with Tracker:</p>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="4">
<tr><td><span class="key">ALT</span>&#160;<span class="key">&uarr;</span></td><td style="width:15px;"></td><td>Opens the parent folder.</td></tr>
@ -70,7 +74,9 @@
<tr><td><span class="key">ALT</span>&#160;<span class="key">SHIFT</span>&#160;<span class="key">Z</span></td><td></td><td>Redo the action you just reverted with <span class="key">ALT</span>&#160;<span class="key">Z</span>.</td></tr>
</table>
<h1><a id="terminal" name="terminal">Shortcuts in Terminal</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="terminal" name="terminal">Shortcuts in Terminal</a></h1>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="4">
<tr><td><span class="key">ALT</span>&#160;<span class="key">N</span></td><td style="width:15px;"></td><td>Opens another Terminal session in a new window.</td></tr>
<tr><td><span class="key">ALT</span>&#160;<span class="key">T</span></td><td></td><td>Opens another Terminal session in a new tab.</td></tr>
@ -89,7 +95,9 @@ are stored in the file <span class="path">~/.bash_history</span>. Press <span cl
<tr><td><span class="key">CTRL</span>&#160;<span class="key">D</span></td><td></td><td>Closes the current Terminal session.</td></tr>
</table>
<h1><a id="other-combos" name="other-combos">Other key combinations</a></h1>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="other-combos" name="other-combos">Other key combinations</a></h1>
<p>You can add or remove items to/from a selection by holding down a modifier key while clicking on a entry (or file in case of Tracker).</p>
<table summary="shortcuts" border="0" cellspacing="0" cellpadding="4">
<tr><td><span class="key">SHIFT</span></td><td style="width:15px;"></td><td>This will select everything between the first selected item and the one you click on.</td></tr>

16
userguide/en/preferences/prefs-appearance.html
View File

@ -42,15 +42,21 @@
</table>
<p>The Appearance preferences lets you change some aspects of Haiku's visuals.</p>
<h1><a id="colors" name="colors">Colors</a></h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="colors" name="colors">Colors</a></h1>
<img src="../images/prefs-images/appearance-colors.png" alt="appearance-colors.png" />
<p>In the first tab, <span class="menu">Colors</span>, you can change the colors of different parts of the user interface. The color well accepts drag&amp;drops from other programs, letting you drag colors over from e.g. <span class="app">WonderBrush</span>, <span class="app">Icon-O-Matic</span> or the <span class="app">Backgrounds</span> panel.</p>
<h1><a id="antialiasing" name="antialiasing">Antialiasing</a></h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="antialiasing" name="antialiasing">Antialiasing</a></h1>
<img src="../images/prefs-images/appearance-antialiasing.png" alt="appearance-antialiasing.png" />
<p>The second tab, <span class="menu">Antialiasing</span>, provides different settings for how things are rendered on screen.</p>
<h2>Glyph hinting</h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
Glyph hinting</h2>
<p>An activated <span class="menu">Glyph hinting</span> aligns all letters in such a way that their vertical and horizontal edges rest exactly between two pixels. The result is a perfect contrast, especially when dealing with black on white. Text appears crisper. There's also a setting for "<span class="menu">Monospaced Fonts Only</span>" that's especially helpful with low resolution devices like netbooks. Small fonts can look pretty bad when hinting is turned on, but with this setting you still have the advantage of hinting for text editors and Terminal.</p>
<p>See the difference hinting makes with these magnified screenshots:</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
@ -58,7 +64,9 @@
</table>
<p>It should be pointed out that all the <span class="app">Magnify</span> windows on this page are of course rendered themselves with the different options as well. So, you get a real world impression of the settings by comparing, for example, the bold yellow tab title or the text "33 x 15 @ 8 pixels/pixel".</p>
<h2>Antialiasing type</h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
Antialiasing type</h2>
<p>Another technique to improve rendering is <i>Antialiasing</i>, which supports all vector graphics as well as text. It smooths lines by changing the color of certain pixels. There are two methods for that:</p>
<p><span class="menu">Grayscale</span> changes the intensity of pixels at the edge.<br />
<span class="menu">LCD subpixel</span> does an even better job, especially with (high resolution) LCD monitors. Instead of the intensity of a pixel, it changes its color which moves an edge by a fraction of a pixel, because LCD displays produce every pixel with a red, green and blue component.</p>

22
userguide/en/preferences/prefs-e-mail.html
View File

@ -59,7 +59,7 @@ width="64" height="64" />E-mail</h1>
The configuration is done in the E-Mail preference panel.</p>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="creating" name="creating">Creating a new e-mail account</a></h1>
<p>Let's go through the process of setting up an e-mail account.<br />
You start by clicking the <span class="button">Add</span> button to create a new, unnamed account. This opens a panel where you fill in your account info:</p>
@ -69,7 +69,7 @@ You start by clicking the <span class="button">Add</span> button to create a new
<p>If your account is from a major e-mail provider, Haiku already knows all technical details like server IP addresses and the following information is already filled in automatically. If that is not the case, just follow this guide and fill in the details to your e-mail account accordingly.</p>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="incoming" name="incoming">Setting up incoming e-mail</a></h1>
<p>Click on <span class="menu">Incoming</span> under your account's name to set up how e-mails are received.</p>
<img src="../images/prefs-images/e-mail-in.png" alt="e-mail-in.png" />
@ -83,7 +83,7 @@ You start by clicking the <span class="button">Add</span> button to create a new
<p>Last on this page, you can opt to only <span class="menu">Partially download messages</span> that are larger than a certain size. This will only get the header and you can decide if you want to download the rest of the message plus possible attachments after seeing the subject and who sent it. Useful if you have a slow connection.</p>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="outgoing" name="outgoing">Setting up outgoing e-mail</a></h1>
<p>Click on <span class="menu">Outgoing</span> under your account's name to set up how e-mails are sent.</p>
<img src="../images/prefs-images/e-mail-out.png" alt="e-mail-out.png" />
@ -92,19 +92,23 @@ You start by clicking the <span class="button">Add</span> button to create a new
<p>If you need to login, you change the <i>Login Type</i> to <span class="menu">ESMTP</span> and enter username and password above. The other type is used for providers that need you to check for mail with <span class="menu">POP3 before SMTP</span> for identification.</p>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="filters" name="filters">Setting up e-mail filters</a></h1>
<p>If you want to filter your incoming email, you click on <span class="menu">E-Mail Filters</span> under your account's name to set up automatic sorting. You can add any number of filters that are applied one after the other. You can rearrange them by drag&amp;dropping them to their new position.<br />
Besides the <span class="menu">R5 Daemon Filter</span> that's used for backward compatibility, there are two other <span class="menu">Incoming Mail Filters</span> you can add.</p>
<h2>Spam Filter</h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
Spam Filter</h2>
<img src="../images/prefs-images/e-mail-filter-spam.png" alt="e-mail-filter-spam.png" />
<p>The spam filter uses statistical methods to classify a mail as unwanted spam. It assigns a value between 0 and 1 to it and you can decide what are the limits for a genuine mail and what will be considered spam.<br />
You can have that spam rating added to the start of the subject.<br />
Also, the spam filter can learn from all incoming e-mail. Of course, you'll have to teach it by sorting out the false positives, mails that were mistakenly marked as spam. You'll find more on that when we discuss the application <span class="app">Mail</span>.</p>
<p>Together with the following <span class="menu">Match Header</span> filter, you're able to automatically sort out detected spam mails.</p>
<h2>Match Header</h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
Match Header</h2>
<img src="../images/prefs-images/e-mail-filter-header.png" alt="e-mail-filter-header.png" />
<p>This filter compares a header to a search pattern and performs some action when it matches.<br />
With the first text field you specify which header to check against. These are available:</p>
@ -139,12 +143,14 @@ With the first text field you specify which header to check against. These are a
<p>The second text field holds your search pattern. It accepts <a href="http://en.wikipedia.org/wiki/Regular_expression" class='external free' title="http://en.wikipedia.org/wiki/Regular expression" rel="nofollow">regular expressions</a> which gives it great flexibility, while unfortunately complicating things a bit. Read up on it a bit, it's well worth it and simple search patterns aren't <i>that</i> complicated at all.</p>
<p>With the drop-down menu below it, you assign an action when the pattern matches. You can move or delete a mail, set the status to "Read" or anything else or set the e-mail account you'll reply with.</p>
<h2>Outgoing Mail Filters</h2>
<h2>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
Outgoing Mail Filters</h2>
<p>At this moment, there's only one filter that deals with outgoing mail: <span class="cli">fortune</span>.
<br />It will attach a randomly chosen funny or wise "fortune cookie" to the end of every mail before it's sent out. You can do a dry run by issuing the command <span class="cli">fortune</span> in a Terminal.</p>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="settings" name="settings">Setting up the mail_daemon</a></h1>
<p>Now that your incoming and outgoing mail servers (and maybe some filters, too), are configured, you have to tell the mail_server that does all the actual mail checking and fetching how to do its job.</p>
<img src="../images/prefs-images/e-mail-settings.png" alt="e-mail-settings.png" />

7
userguide/en/preferences/prefs-fonts.html
View File

@ -51,12 +51,14 @@
<tr><td><span class="button">Revert</span></td><td>&#160;</td><td>brings back the settings that were active when you started the Fonts preferences.</td></tr>
</table>
<h1><a id="install" name="install">Installing new fonts</a></h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="install" name="install">Installing new fonts</a></h1>
<p>You install new fonts by copying them into their respective user folder, i.e. <span class="path">/boot/common/fonts/</span> or <span class="path">/boot/home/config/fonts/</span> (see topic <a href="../filesystem-layout.html">Filesystem layout</a>).</p>
</div>
<!--
<div class="bottomnav">
<p>
&laquo;&#160;&#160;<a href="prefs-filetypes.html">FileTypes</a>
@ -66,7 +68,6 @@
<a href="prefs-keyboard.html">Keyboard</a>&#160;&#160;&raquo;
</p>
</div>
-->
</body>
</html>

4
userguide/en/preferences/prefs-keymap.html
View File

@ -60,7 +60,9 @@ When you're done you can save the result from the menu <span class="menu">File |
<p>The font used in the keyboard representation is set from the <span class="menu">Font</span> menu. Note, that it may or may not contain all symbols for a specific keymap.</p>
<p>Finally, there's a <span class="button">Revert</span> button to bring back the settings that were active when you started the Keymap preferences.</p>
<h1><a id="advanced-keymapping" name="advanced-keymapping">Advanced keymap manipulation</a></h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="advanced-keymapping" name="advanced-keymapping">Advanced keymap manipulation</a></h1>
<p>There's another method to customize your keymap besides the Keymap preference panel. It involves editing a text file containing loads of hex values, which may appear daunting on first sight, but isn't really that impossible to grasp.</p>
<p>You can dump the current keymap with a command in Terminal:<p>
<pre class="terminal">keymap -d MyKeymap</pre>

8
userguide/en/preferences/prefs-screensaver.html
View File

@ -46,7 +46,9 @@ width="64" height="64" />ScreenSaver</h1>
<p>The panel of the ScreenSaver preferences is split into two tabs:
</p>
<h1><a name="fade">Fade</a></h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a name="fade">Fade</a></h1>
<img src="../images/prefs-images/screensaver-fade.png" alt="screensaver-fade.png" >
<br />
<p>The top checkbox enables/disables the screen saver.<br />
@ -59,7 +61,9 @@ The other, after how many minutes you need a password to unlock your machine.
<p>By clicking into different corners of the two screens at the bottom, you tell the system when to immediately start the screen saver or when to prevent it from kicking in when you rest the mouse in the indicated corner. Click in the middle of the screens to disable that feature again.
</p>
<h1><a name="modules">Modules</a></h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a name="modules">Modules</a></h1>
<img src="../images/prefs-images/screensaver-modules.png" alt="screensaver-modules.png" />
<br />
<p>The second tab shows a list of all installed screen saver modules and their individual settings. You can test your settings with the <span class="button">Test</span> button below the list and add modules with the <span class="button">Add...</span> button beside it. Other ways to install new screen savers is by a simple drag&amp;drop into the list. Of course, you can also copy/delete a module's file in its respective user folder, i.e. <span class="path">/boot/common/add-ons/screensavers/</span> or <span class="path">/boot/home/config/add-ons/screensavers/</span> (see topic <a href="../filesystem-layout.html">Filesystem layout</a>).

8
userguide/en/preferences/prefs-time.html
View File

@ -46,7 +46,9 @@
</table>
<p>The panel of the Time preferences is split into two tabs:</p>
<h1><a id="date-time" name="date-time">Date &amp; Time</a></h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="date-time" name="date-time">Date &amp; Time</a></h1>
<img src="../images/prefs-images/time-time.png" alt="time-time.png" />
<p>On the left side, you can set the day of the month by simply clicking on it in the calendar. You change the month and year by clicking on it and using the up/down arrows to the right or the cursor keys on your keyboard.</p>
<p>Similarly, you set the time. There are two modes for the clock:</p>
@ -55,7 +57,9 @@
<tr><td><span class="menu">GMT</span></td><td>&#160;</td><td>to display Greenwich Mean Time.</td></tr>
</table>
<h1><a id="timezone" name="timezone">Timezone</a></h1>
<h1>
<a href="#logo"><img src="../../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="timezone" name="timezone">Timezone</a></h1>
<img src="../images/prefs-images/time-timezone.png" alt="time-timezone.png" />
<p>Simply find and choose your location from the drop-down menu and the list of cities and press <span class="button">Set Time Zone</span> to set your zone.</p>
<p><span class="button">Revert</span> brings back the settings that were active when you started the Time preferences.</p>

10
userguide/en/queries.html
View File

@ -54,7 +54,7 @@
Even better, you don't have to double-click to re-do a query. You can <a href="tracker.html#navigating">drill down</a> a saved query just like any folder by right-clicking on it and navigating through the submenus.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="find-window" name="find-window">The Find window</a></h1>
<p>You start a query by invoking the <span class="menu">Find...</span> menu either from the Deskbar menu or any Tracker window or the Desktop (which is actually a fullscreen Tracker window). The shortcut is <span class="key">ALT</span>&#160;<span class="key">F</span>. You're presented with the Find window:</p>
<img src="images/queries-images/basic-query.png" alt="basic-query.png" />
@ -76,12 +76,12 @@ types.</p></li>
</ol>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="basic-query" name="basic-query">Basic queries - "by Name"</a></h1>
<p>If you simply want to find all files on your mounted disks that match a certain pattern, simply leave the search method at "<span class="menu">by Name</span>", enter the search term into the text box and press <span class="key">ENTER</span>.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="adv-query" name="adv-query">Advanced queries - "by Attribute"</a></h1>
<p>You can create more advanced queries by searching within the attributes of specific file types. For that to work, these attributes have to be <a href="index.html">indexed</a>.</p>
<img src="images/queries-images/query-window.png" alt="query-window.png" />
@ -92,7 +92,7 @@ types.</p></li>
<p>This is your Find window when you're looking for all emails Clara Botters has sent to you in the last two months that had in the subject "vibraphone" or "skepticality".</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="more-adv-query" name="more-adv-query">Even more advanced queries - "by Formula"</a></h1>
<p>Typing in a formula query by hand is daunting and really quite unpractical. It still has its uses.</p>
<p>Take the above query by attribute of Clara's mails concerning vibraphones etc. If you have all the attributes and their search terms set, try switching to "<span class="menu">by Formula</span>" mode and be overwhelmed by this one line query string:</p>
@ -111,7 +111,7 @@ types.</p></li>
</ul>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="result-window" name="result-window">The result window</a></h1>
<p>After you start a search, the Find window will be replaced by a result window. Here is an example that queried for "server":</p>
<img src="images/queries-images/result-window.png" alt="result-window.png" />

21
userguide/en/tracker.html
View File

@ -55,7 +55,7 @@
<p>Being an application like any other (the Desktop with its icons is really just a fullscreen window in the background), Tracker appears with its windows in the Deskbar and can be quit and restarted. The easiest way to quit and restart a crashed or frozen Tracker (or a wayward Deskbar) is to call the <a href="teammonitor.html">Team Monitor</a>.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="mounting-volumes" name="mounting-volumes">Mounting Volumes</a></h1>
<p>In order to access a harddisk, CD, USB stick etc., you first have to mount the volume, that is, let the system know it's there. This is done with a right-click on the Desktop or an already mounted volume (like the boot disk) and choosing the volume from the <span class="menu">Mount</span> submenu. You find the same <span class="menu">Mount</span> menu in the Deskbar.</p>
<img src="images/tracker-images/mount-settings.png" alt="drill-down.png" />
@ -64,14 +64,15 @@ The above settings will automatically mount any storage device you connect/inser
<div class="box-warning">Before you disconnect e.g. a harddrive or USB stick, make sure you have successfully unmounted the volume. This guarantees that all data transfer has finished. Otherwise you may lose data or corrupt the disk!</div>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="navigating" name="navigating">Navigating</a></h1>
<p>By default, when you double-click a folder, Tracker opens a new window while leaving the parent window open. This can quickly lead to an overcrowded desktop.<br />
You can prevent that by holding down the <span class="key">OPT</span> key, which automatically closes the parent window.<br />
This is also true for keyboard navigation. For more on that, see topic <a href="keyboard-shortcuts.html">Shortcuts and key combinations</a>.</p>
<p>Moving through your folders is one of Trackers main purposes, just like the file managers on other platforms. Haiku's Tracker has some unique features that will help you doing that efficiently.</p>
<h2><a id="drill-down" name="drill-down">Drilling down the submenus</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a><a id="drill-down" name="drill-down">Drilling down the submenus</a></h2>
<p>Instead of double-clicking your way down folder after folder, there's a better way to drill down:</p>
<img src="images/tracker-images/drill-down.png" alt="drill-down.png" />
<!-- screenshot needs updating to show /boot/system/documentation -->
@ -83,13 +84,15 @@ If you do the above while dragging a file with you, it will be moved to where yo
<p>Note, that the Desktop is always the topmost level as that is where Tracker shows mounted volumes. So, if you want to go to another disk, you first have to navigate to the top (Desktop) and cross over to your other disk from there.</p><br />
<p>You'll get the same submenu-navigating when you drag a file over a folder. After a short while of hovering, a submenu pops up and you can drill down to your destination. If you initiated the drag with the right mousebutton, you can choose between copying, moving or linking the file when you release the mouse.</p>
<h2><a id="type-ahead" name="type-ahead">Jumping to files with type-ahead</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="type-ahead" name="type-ahead">Jumping to files with type-ahead</a></h2>
<p>You may be familiar with the concept from file managers of other operating systems: typing the first few letters of a filename will jump to the first file matching these starting characters. Haiku took the idea a step further. If there isn't a file starting with those letters it will jump to the first file including the string anywhere in its name. And if there's nothing with the string in its filename, the attributes are searched next.</p>
<img src="images/tracker-images/window-type-ahead.png" alt="window-type-ahead.png" />
<p>In the above example, there are many files starting with "Haiku logo", rendering simpler approaches to typing ahead quite useless. In Haiku however, typing "web" jumps right to its first occurence in "Haiku logo - website". The characters you enter appear in the bottom left corner where you normally find the item count of all files in the folder. A second after entering a character, the display jumps back to normal and you're ready for a new type ahead search.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="appearance" name="appearance">Appearance</a></h1>
<img src="images/tracker-images/window-menu.png" alt="window-menu.png" />
<p>Tracker windows offer three different viewing modes from the <span class="menu">Window</span> menu:</p>
@ -109,7 +112,9 @@ If you do the above while dragging a file with you, it will be moved to where yo
<p>Sometimes you just want to rearrange a few icons without doing a complete <span class="menu">Clean Up</span> (<span class="key">ALT</span>&#160;<span class="key">K</span>). In that case, you select these icons and start to drag them to their new location. Before you drop them there, keep <span class="key">ALT</span> pressed. This will align the icons to the invisible grid.</p>
<p>The rest of the functions are pretty self-explanatory, leaving the Tracker preferences.</p>
<h2><a id="tracker-preferences" name="tracker-preferences">Tracker preferences</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="tracker-preferences" name="tracker-preferences">Tracker preferences</a></h2>
<p><span class="menu">Window | Preferences...</span> opens a panel that offers a number of settings that, where not obvious, should become clear once tried out. Since all settings are applied live, you'll immediately see the changes.
<br />So, in short, the not so obvious settings:</p>
<ul>
@ -126,7 +131,7 @@ If you do the above while dragging a file with you, it will be moved to where yo
<p>This panel, by the way, is also available as <span class="app">Tracker</span> from Deskbar's <span class="menu">Preferences</span>.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="working-with-files" name="working-with-files">Working with files</a></h1>
<p>When invoked on a selected file, most of the <span class="menu">File</span> menu commands are also offered in the context menu by right-clicking that file.</p>
<p>As usual the commands are pretty clear.</p>
@ -157,7 +162,7 @@ If you do the above while dragging a file with you, it will be moved to where yo
</ul>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="transaction-status" name="transaction-status">Transaction status</a></h1>
<p>When you copy, move or delete files, Tracker shows its progress with a status window. If you initiate more than one transaction, each job gets its own status display.</p>
<img src="images/tracker-images/transaction-status.png" alt="transaction-status.png" />

20
userguide/en/workshop-filetypes+attributes.html
View File

@ -59,7 +59,7 @@
<p>This is a workshop to show the use of <a href="attributes.html">Attributes</a>, <a href="queries.html">Queries</a>, the <a href="index.html">Index</a> and custom <a href="filetypes.html">Filetypes</a>. As an example, we build a database to keep track of our DVD library.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="preparations" name="preparations">Preparations</a></h1>
<p>Let's first decide what filetype and attributes would serve our needs. Originally, I wanted to use a Bookmark file with a link to the movie's IMdB page, but Haiku doesn't have a "bookmarkable" browser like BeOS' <span class="app">NetPositive</span> at the moment, so I came up with this: The file itself will be a JPEG image for the movie cover.<br />
To that we add a couple of attributes. Here we have to decide if we want to query it later (then we have to add it to the index) and if so, what type of attribute it should be. Numbers (int, float) can be evaluated differently than text (&lt;/=/&gt; vs. is/contains/starts with).</p>
@ -76,7 +76,7 @@ To that we add a couple of attributes. Here we have to decide if we want to quer
</ul>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="custom-filetype" name="custom-filetype">Creating a custom filetype</a></h1>
<p>Start the <span class="app">Filetypes</span> preferences, and click on the <span class="button">Add...</span> 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 "<i>applications</i>" and set the "Internal Name" to <i>DVDdb</i>.</p>
<img src="images/workshop-filetypes+attributes-images/filetypes-new-file-type.png" alt="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
<img src="images/workshop-filetypes+attributes-images/filetypes-dvddb.png" alt="filetypes-dvddb.png" />
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="icon" name="icon">Icon</a></h2>
<p>Double-click the icon well to open <a href="applications/apps-icon-o-matic.html">Icon-O-Matic</a> to design an icon for your filetype. You can also drag&amp;drop an icon from the icon well of another type, maybe as starting point for a modified version.</p>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="file-recognition" name="file-recognition">File Recognition</a></h2>
<p>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.</p>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="decription" name="decription">Description</a></h2>
<ul>
<li><i>Type Name</i> - Appears e.g. in the Attribute menu of Tracker windows and the "Kind" attribute of a file.</li>
@ -102,7 +102,7 @@ To that we add a couple of attributes. Here we have to decide if we want to quer
</ul>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="pref_app" name="pref_app">Preferred Application</a></h2>
<p>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.</p>
<table summary="layout" border="0" cellspacing="0" cellpadding="2">
@ -111,7 +111,7 @@ To that we add a couple of attributes. Here we have to decide if we want to quer
</table>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="extra_attribute" name="extra_attribute">Extra Attributes</a></h2>
<p>Here we enter all the custom attributes we decided on in our preparations. Clicking the <span class="button">Add...</span> button opens a panel:</p>
<img src="images/workshop-filetypes+attributes-images/filetype-extra-attribute.png" alt="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
</table>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="indexing" name="indexing">Indexing</a></h1>
<p>Before we start entering data in our little DVD database, we should add certain attributes to the <a href="index.html">Index</a>. Only indexed attributes can use Haiku's fast <a href="queries.html">Queries</a>.<br />
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'?".</p>
@ -173,7 +173,7 @@ mkindex -t int DVDdb:rating</pre>
<p>The <span class="cli">-t</span> option defines the type of attribute, which is "string" for all but the rating, which is an integer number.</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="filling-data" name="filling-data">Filling in the data</a></h1>
<p>Now, everything's set and we can begin putting some data into our base.<br />
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.</p>
@ -185,7 +185,7 @@ Since our basic file is a cover image, we go to some online resource like IMdB,
<p>Right-clicking into a Tracker window, you'll find a new entry under <span class="menu">New...</span> besides the default "New folder".</p>
<h1>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" width="16" height="16" class="noprint" /></a>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="query-db" name="query-db">Querying the database</a></h1>
<p>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... :)</p>
<p>You can assign a sensible attribute layout for query results of a specific filetype.<br />

12
userguide/en/workspaces.html
View File

@ -53,16 +53,22 @@
<span class="menu">Change Workspace Count...</span> will open the <a href="preferences/prefs-screen.html">Screen</a> preferences where you set the number of workspaces and their arrangement (how many rows and columns).</p>
<p>Since the applet is a Replicant, you can resize the window as desired and then drag&amp;drop it by its handle onto the desktop (make sure "<span class="menu">Show Replicants</span>" is activated in the Deskbar menu).</p>
<h2><a id="switching" name="switching">Switching workspaces</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="switching" name="switching">Switching workspaces</a></h2>
<p>You switch between workspaces by either clicking into the Workspaces applet or by using the keyboard shortcut <span class="key">ALT</span>&#160;<span class="key">Fx</span>, 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 <span class="key">Fx</span> keys on the keyboard.<br />
Also, clicking on an application or one of its windows in the Deskbar will send you to the workspace it's in.</p>
<p>Another very convenient way is to use <span class="key">CTRL</span>&#160;<span class="key">ALT</span>&#160;<span class="key">&larr;</span>/<span class="key">&rarr;</span>/<span class="key">&uarr;</span>/<span class="key">&darr;</span> to navigate spatially the rows/columns of the available workspaces.</p>
<p>You can switch back and forth between two workspaces with <span class="key">ALT</span>&#160;<span class="key">~</span> (which, depending on the keymap you're using, is the key below <span class="key">ESC</span>, which you have to hit twice to get a <tt>~</tt>).</p>
<h2><a id="moving" name="moving">Moving windows between workspaces</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="moving" name="moving">Moving windows between workspaces</a></h2>
<p>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 <span class="key">ALT</span>&#160;<span class="key">Fx</span>.</p>
<h2><a id="special" name="special">Special functionality</a></h2>
<h2>
<a href="#logo"><img src="../images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="special" name="special">Special functionality</a></h2>
<p>The Workspaces applet provides some additional functionality when clicking on a window while holding certain modifier keys:
<table summary="functionality-thru-modifiers" border="0" cellspacing="0" cellpadding="4">
<tr><td><span class="key">CTRL</span></td><td style="width:15px;"></td><td>Brings the the window to the foreground.</td></tr>

BIN
userguide/images/apps-images/magnify.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 7.8 KiB

BIN
userguide/images/up.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 329 B

After

Width:  |  Height:  |  Size: 379 B

BIN
welcome/images/up.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 329 B

After

Width:  |  Height:  |  Size: 379 B

23
welcome/welcome.html
View File

@ -29,10 +29,13 @@
<div class="content">
<h1><a id="welcome" name="welcome">Welcome to Haiku!</a></h1>
<h1>
<a id="welcome" name="welcome">Welcome to Haiku!</a></h1>
<p>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 <i>alpha release</i> 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.</p>
<h1><a id="bugreport" name="bugreport">Beware of Bugs</a></h1>
<h1>
<a href="#logo"><img src="./images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="bugreport" name="bugreport">Beware of Bugs</a></h1>
<p>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.<p>
<div class="box-warning">We discourage using alpha versions as a production system. Your data could very well be altered, mangled or downright destroyed.</div>
@ -42,14 +45,18 @@
<li><a href="en/bugreports.html">Tips for a helpful bug report</a></li>
</ul>
<h1><a id="system" name="system">Getting to know the system</a></h1>
<h1>
<a href="#logo"><img src="./images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="system" name="system">Getting to know the system</a></h1>
<p>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:</p>
<ul>
<li><a href="../userguide/en/contents.html">Haiku User Guide</a></li>
<li><a href="http://www.haiku-os.org/community/" class="printurl">List of BeOS/Haiku websites</a></li>
</ul>
<h1><a id="software" name="software">Installing more software</a></h1>
<h1>
<a href="#logo"><img src="./images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="software" name="software">Installing more software</a></h1>
<p>Because of our binary and source compatibility, many BeOS applications run on Haiku. After downloading a package, simply unzip it (double clicking opens <span class="app">Expander</span>) to <span class="path">/boot/apps/</span> and start the application from there.</p>
<div class="box-info">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 <span class="path">/</span>.</div>
@ -62,7 +69,9 @@
<li><a href="http://www.osdrawer.net/" class="printurl">OsDrawer</a> hosts native BeOS and Haiku open source software projects</li>
</ul>
<h1><a id="api" name="api">Getting to know the API</a></h1>
<h1>
<a href="#logo"><img src="./images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="api" name="api">Getting to know the API</a></h1>
<p>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.</p>
<p>There are additional resources that should help you getting started:</p>
@ -73,7 +82,9 @@
<li><a href="http://www.haiku-os.org/legacy-docs/benewsletter/" class="printurl">BeNewsletter Archive</a></li>
</ul>
<h1><a id="contact" name="contact">Getting in contact</a></h1>
<h1>
<a href="#logo"><img src="./images/up.png" align="right" alt="index" border="0" class="noprint" /></a>
<a id="contact" name="contact">Getting in contact</a></h1>
<p>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 <a href="http://www.haiku-os.org/node/2517">Mailing List Etiquette</a>.</p>
<ul>
<li><a href="http://www.haiku-os.org/community/irc" class="printurl">IRC channels</a></li>