Contribution by Humdinger:

Firt version of the "Welcome Package" introductory documentation.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27846 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Stephan Aßmus 2008-10-03 08:03:14 +00:00
commit d58cc3e252
42 changed files with 1077 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

138
welcome/attributes.html Normal file
View File

@ -0,0 +1,138 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Attributes</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br><br>
<h2>Attributes</h2>
<p>Attributes are data fields that belong to a file but aren't part of that file, e.g. they are not computed into the file size and can be copied or changed without touching the file itself. The system uses these attributes to store e.g. file size, file type or date of the last modification. This is similar to other operating systems and their filesystems.
</p><p>What's different is that you can add any kind of attribute to any file and display it or make it editable in a Tracker window. You just have to define the kind of attribute you want to add to a file type (e.g. string, integer or time) and give it a name and description.
</p><p>The file itself doesn't even need any contents at all. Take a look at these People files for example:
</p>
<img src="attributes-images/people.png" alt="people.png" width="841" height="250"
<br>
<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>
<br>
<h3>Attributes in Tracker</h3>
<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 <i>Attributes</i> 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 <tt>SHIFT</tt> 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 dotted line under the heading.
</p><p>Editing these attributes is as simple as renaming a file: Either click on an entry or press <tt>ALT+E</tt> and move between the attibutes with <tt>TAB</tt> and <tt>SHIFT+TAB</tt>. <tt>ESC</tt> leaves the editing mode without applying the changes.
</p>
<br>
<h3>Attributes in Terminal</h3>
<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>
<p>From our screenshot example above:
</p>
<pre>55 ~/people -&gt;listattr Clara\ Botters
File: Clara Botters
Type Size Name
----------- --------- -------------------------------
MIME String 21 &quot;BEOS:TYPE&quot;
Text 14 &quot;META:name&quot;
Text 6 &quot;META:nickname&quot;
Text 1 &quot;META:company&quot;
Text 18 &quot;META:address&quot;
Text 8 &quot;META:city&quot;
Text 1 &quot;META:state&quot;
Text 1 &quot;META:zip&quot;
Text 1 &quot;META:country&quot;
Text 1 &quot;META:hphone&quot;
Text 13 &quot;META:wphone&quot;
Text 1 &quot;META:fax&quot;
Text 19 &quot;META:email&quot;
Text 1 &quot;META:url&quot;
Text 5 &quot;META:group&quot;
Raw Data 20 &quot;_trk/pinfo_le&quot;
131 bytes total in attributes.</pre>
<p>Besides all the "<tt>META:*</tt>" attributes that hold the contact's information, there are two attributes that are managed by the system:
</p><p>
<ul><li><tt>BEOS:TYPE</tt> holds the file type as a MIME string, here "<tt>application/x-person</tt>. It determines the default icon and the application that opens the file when you e.g. double click it.</li>
<li>"<tt>_trk/pinfo_le</tt>" is kept by Tracker as... I'm not sure, I'm still investigating...&nbsp;:)</li></ul></p>
<p>Note the backslash after "Clara". In Terminal you have to "escape" special characters like '"*\$?!. The space between "Clara" and "Botters" is also one of those. Therefore the backslash is really in front of the space character, and not after "Clara".</li>
<p><br>
</p>
<li><b>catattr</b> - displays the contents of a specific attribute of a file.
<pre>usage: catattr [--raw|-r] attr_name file1 [file2...]</pre>
<p>Again our example:
</p>
<pre>56 ~/people -&gt;catattr META:city Clara\ Botters
Clara Botters&nbsp;: string&nbsp;: Whelton</pre></li>
<p><br />
</p>
<li><b>addattr</b> - adds an attribute to a file and/or fills it with a value.
<pre>usage: addattr [-t type] attr value file1 [file2...]
or: addattr [-f value-from-file] [-t type] attr file1 [file2...]
Type is one of:
string, mime, int, llong, float, double, bool, raw
or a numeric value (ie. 0x1234, 42, 'ABCD', ...)
The default is &quot;string&quot;</pre>
<p>So, say dear Clara took a job with the multi-national Barkelbaer Inc., you fill
the formerly empty "Company" attribute with that data (which is of type
"string"):
</p>
<pre>addattr -t string META:company Barkelbaer\ Inc. Clara\ Botters</pre>
</li>
<p><br />
</p>
<li><b>rmattr</b> - completely removes an attribute from a file.
<pre>usage: rmattr [-p] attr filename1 [filename2...]
'attr' is the name of an attribute of the file
If '-p' is specified, 'attr' is regarded as a pattern.</pre>
<p>Though in all practicality it would be enough to just not fill the "Fax"
attribute, you can completely remove it from Clara's file by typing:
</p>
<pre>rmattr META:fax Clara\ Botters</pre></li>
<p><br />
</p>
<li><b>copyattr</b> - copies attributes from one or more files to another. By
default, the actual contents of the file is <b>not</b> copied.
<pre>Usage: copyattr &lt;options&gt; &lt;source&gt; [ ... ] &lt;destination&gt;</pre>
<p>If you do want to copy the attributes plus the data of the file itself, you can
</p>
add the option "<tt>-d</tt>" or "<tt>--data</tt>".</li>
</ul>
<p><br />
More information on these commands and their options can be found by typing the
command name followed by "<tt>-h</tt>" or "<tt>--help</tt>".
</p>
</TD></TR>
</TABLE>
</BODY>
</HTML>

47
welcome/bugreports.html Normal file
View File

@ -0,0 +1,47 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Bugreporting</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br><br>
<h2>Reporting bugs</h2>
<p>Since our developers are unable to test every hardware combination, nor every different way of interacting with the operating system, we are relying on you to give us some input on how things work at your end. Since this is a very early product, it is very likely that you will encounter bugs. We thank you for taking the time to report these.<br><br>
Please follow these guidelines to create helpful bug reports:</p>
<ol><li>Before reporting a bug please <a href="http://dev.haiku-os.org/query?status=new&status=assigned&status=reopened&status=closed&summary=~text+you+want+to+search+for&order=priority">make sure</a> that it does not yet exist. You can also use the <a href="http://dev.haiku-os.org/search?q=&noquickjump=1&ticket=on">search</a> function for this.<br><br></li>
<li>After you have established this is a unique bug, make your information as accurate as possible:<br><br>
<ul>
<li>Include basic information such as how you are testing Haiku (on real hardware, on VMWare, on QEMU, etc.).<br><br></li>
<li>Mention which revision from SVN you are running. You can find this information in '<i>About This System...</i>' from the Deskbar menu.<br><br></li>
<li>Describe the problem you are experiencing. Try to be as accurate as you can: describe the actual behavior, and the behavior you expected.<br><br></li>
<li>Describe what steps to you need to perform in order to expose the bug. This will help developers reproduce the bug.<br><br></li>
<li>Attach as much information as you have. If it is a GUI bug, or a bug in one of the applications, try to make a screen shot (the <tt>PRINT</tt> key files a PNG into <tt>/boot/home/</tt>).<br>If it is a hardware problem, include a copy of the <tt>syslog</tt> file (just query for "<tt>syslog</tt>" to find it).</li>
</ul></li><br>
<li>After the bug has been reported, a developer will look at your bug and try to classify it. Remember, we are all volunteers, and as such, sometimes a bug report might go unanswered for a while. Adding new information when it becomes available usually helps getting a bug picked up quicker, but do not try to 'bump' the bug up by adding non-descriptive comments.<br><br></li>
<li>Remember, reporting a bug is not something you spend a little time on and then you are done. If you reported a bug, then you are part of the Haiku development process. Developers might come up with questions while they are trying to fix your bug. Please stay around to answer these. Consider your participation 'done' when the bug is marked as 'fixed'. Together we can improve Haiku, bit by bit.
</li></ol>
</TD></TR>
</TABLE>
</BODY>
</HTML>

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

88
welcome/deskbar.html Normal file
View File

@ -0,0 +1,88 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>The Deskbar</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br><br>
<h2>The Deskbar</h2>
<p>The Deskbar is the little panel that by default is located in the upper right corner of the screen. It's Haiku's version of Windows' taskbar with its Start button. It contains the Deskbar menu from where you can start applications and preferences, a tray with a clock and other tools below that and a list of currently running programs at the bottom.
</p>
<img src="deskbar-images/positions.png" alt="positions" width="640" height="480"</a>
<br>
<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. The Deskbar has to be in this compacted format when it's put in the lower corners of the screen.
</p><br>
<h3>The Deskbar Menu</h3>
<p>A menu opens when you click on the Deskbar's uppermost part:
<br>
<img src="deskbar-images/settings.png" alt="settings.png" width="521" height="309"</a>
<br>
<ul>
<li><i>About This System...</i> -- Shows some basic information of the system, licenses and the credits of the Haiku project.</li>
<li><i>Find...</i> -- Opens the query dialog.</li>
<li><i>Show Replicants</i> -- Shows/hides the little Replicant widget you use to drag it around, remove or access its context menu.</li>
<li><i>Deskbar Settings</i><ul>
<li><i>Configure Deskbar Menu...</i> -- Opens a panel to configure the Deskbar menu (see below).</li>
<li><i>Always on Top</i> -- The Deskbar always stays above all other windows.</li>
<li><i>Auto Raise</i> -- The Deskbar pops to the front if the mouse pointer touches it.</li>
<li><i>Sort Running Applications</i> -- Sorts the list of running programs alphabetically.</li>
<li><i>Tracker always First</i> -- Even if you sort alphabetically, the Tracker entry always stays first in the list.&lt;/i&gt;</li>
<li><i>24 Hour Clock</i> -- Toggles between 24 and 12 hour clock.</li>
<li><i>Show Seconds</i> -- Adds the display of seconds to the clock.</li>
<li><i>European Date</i> -- Shows the date in European format: day-month-year</li>
<li><i>---- Full Date ----</i></li>
<li><i>Show Application Expander</i> -- Provides a small widget to show/hide all windows of a program directly under its entry in the Deskbar.</li>
<li><i>Expand New Applications</i> -- Newly launched programs have their windows automatically expanded under their entry in the Deskbar.</li>
</ul></li>
<li><i>Restart</i> -- Restarts the system.</li>
<li><i>Shutdown</i> -- Shuts down the system.</li>
<li><i>Recent Documents, Folders, Applications</i> -- List the last recently opened documents, folders and applications (see <i>Configure Deskbar Menu...</i> below).
<li><i>Applications, Demos, Deskbar Applets, Preferences</i> -- List of installed applications, demos, applets and preferences (see <i>Configure Deskbar Menu...</i> below).</li>
</ul>
<br>
<h4>Configure Deskbar Menu...</h4>
<p>
<img src="deskbar-images/configure.png" alt="configure.png" width="359" height="416"</a>
</p><p>In this panel you set how many recent documents, folders and applications are shown in the Deskbar, or if you show them at all.
</p><p>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.
This part of the panel is just a representation of the folder <tt>/boot/home/config/be</tt>. You can just as well link or copy files and folders directly in Tracker to configure your Deskbar.
</p><p><br>
</p>
<h3>The Tray</h3>
<img src="deskbar-images/calendar.png" alt="calendar.png" width="229" height="210"</a>
<p>Among other things, the tray's housing the clock. Left-click it to toggle between date and time. Right-click it to hide/show it or launch the <i>Time</i> preferences to set it.
Here you can also launch a calendar that also appears, when you hold down the left mouse button on the clock for a little time.
</p><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. <i>ProcessController</i> is another example that uses its icon in the tray to provide information (CPU/memory usage) and to offer a context menu.
</p><p><br>
</p>
<h3> The list of running programs</h3>
<img src="deskbar-images/list-of-apps.png" alt="list-of-apps.png.png" width="229" height="306"</a>
<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><p>If you activated Expanders in the Deskbar settings, you can show/hide the list of windows directly under an application's entry.
</p><p>In front of every application's windows is a symbol providing info on its state. A bright symbol means a window is visible, a dark one that it's minimized. Three lines in front of a symbol shows that it's not on the current workspace.
</p>
</TD></TR>
</TABLE>
</BODY>
</HTML>

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

70
welcome/filetypes.html Normal file
View File

@ -0,0 +1,70 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Filetypes</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br><br>
<h2><a name="filetypes">Filetypes</a></h2>
<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 MIME types just like it's custom on the internet.</p>
<br>
<h3><a name="specific-file">Setting the filetype of a specific file</a></h3>
<p>You can change the type of a specific file, its icon and the associated application. Select the file and invoke the Add-Ons | Filetype add-on from the right-click context menu.
</p>
<img src="filetypes-images/filetype-addon.png" alt="filetype-addon.png" width="288" height="212">
<br>
<h4><a name="filetype">The File Type</a></h4>
<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:
<ul><li><i>Select...</i> shows a hierarchical list of filetypes where you navigate to <tt>image | GIF Image</tt>.</li>
<li><i>Same as...</i> opens a file dialog where you choose any file that already has the filetype you're looking for.</li></ul>
</p>
<h4><a name="preferred-app">The Preferred Application</a></h4>
<p>This dropdown 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 "Default Application" 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 dropdown menu, you'll again find the buttons Select... and Same As... which do the similar thing described under "The File Type" above. </p>
<h4><a name="icon">The Icon</a></h4>
<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 <i>Filetype Add-On</i> of a file that contains an icon and drag&drop it into your file's icon well. Or you double-click the icon well and create or edit your own icon in <i>Icon-O-Matic</i>.</p>
<br><br>
<h3><a name="filetypes-preferences">Global settings with the Filetypes Preferences</a></h3>
<p>The <i>Filetypes</i> 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 <tt>/boot/home/config/settings/beos_mime</tt>. Before you start experimenting, it may be prudent to make a backup of that folder... </p>
<p>To learn more about the <i>Filetypes</i> preferences see the workshop: <a href="Workshop-Filetypes+Attributes.html">DVDdb (Filetypes & Attributes)</a>.</p>
<br>
<h3><a name="settings-apps">Special settings for applications</a></h3>
<p>If you invoke the <i>Filetype Add-On</i> on an executable (here: <i>StyledEdit</i>), you'll get a different dialog:</p>
<img src="filetypes-images/filetype-addon-stylededit.png" alt="filetype-addon-stylededit.png" width="353" height="422">
<br>
<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>
<p>Below it are several flags, controlling the app's behaviour:
<ul><li><i>Single Launch</i> - Only one instance of the app can be running per executable file. If you have two copies of that app, however, they can run side by side.</li>
<li><i>Multiple Launch</i> - Many instances of the app can run simultaneously.</li>
<li><i>Exclusive Launch</i> - Really only one instance with that app's signature is allowed to run at a time.</li>
<li><i>Args Only</i> - Indicates the app doesn't respond to messages.</li>
<li><i>Background App</i> - The app won't appear in Twitcher or the list of running apps of the Deskbar.</li>
</ul>
<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 <i>Open with...</i> 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>
</TD></TR>
</TABLE>
</BODY>
</HTML>

BIN
welcome/gui-images/gui.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

52
welcome/gui.html Normal file
View File

@ -0,0 +1,52 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Haiku's GUI</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br><br>
<h2>Haiku's GUI</h2>
<p>Haiku's graphical user interface is an integral part of the system. Unlike linux-based operating systems, there's no separate windows manager and just booting into a commandline shell is not possible. Haiku's focus being on the desktop user, this is just not considered necessary.
</p><p>As you probably have experience with other graphical environments, let's skip over the standards like menus, right-click context menus, drag&drop etc. Let's have a look at the few unique aspects of Haiku's GUI instead.</p>
</p><br>
<p>Before we start with that, there's one more thing you'll probably run into quite quickly: By default, Haiku's option key, to invoke commands from menus for example, is not the usual <tt>CTRL</tt> key, but <tt>ALT</tt> instead. This has historical reasons, because the BeOS was inspired somewhat by MacOS. After you get used to it, it actually feels better as e.g. <tt>ALT+C</tt> and <tt>ALT+V</tt> is reached more conveniently on the keyboard and these commands seemlessly integrate into the bash shell of the Terminal.
</p><p>In any case, you can switch to the maybe more familiar <tt>CTRL</tt> key in the <i>Menu</i> preferences.
</p>
<br />
<img src="gui-images/gui.png" alt="gui.png" width="644" height="404"
</p><p><br />
There are only a few things in Haiku's GUI that aren't obvious and deserve an explanation.
</p><p>
[1] The Deskbar is Haiku's "Start" menu and taskbar, if you will. See topic <a href="deskbar.html">Deskbar</a>.<br>
[2] The yellow tab offers more than just a program's name or a document's filename:<ul><li>You can move it by holding the <tt>SHIFT</tt> key while dragging it to another position, enabling you to stack a number of windows and conveniently access them by their named tab.</li>
<li>You minimize a window with a double-click on its tab. A such hidden window can be accessed by its entry in the <a href="deskbar.html">Deskbar</a> or the <a href="twitcher.html">Twitcher</a>.</li>
<li>You can send a window to the back with a right-click on its tab (or its border).</li></ul>
[3] The close button.<br>
[4] The maximise button.<br>
[5] The resize button. Dragging anywhere else on a window's border will move the window.<br>
</p><p>That's pretty much all there is to Haiku's GUI widgets in general. You'll find more information in <a href="welcome.html#system">Getting to know the system</a>.
</p>
</TD></TR>
</TABLE>
</BODY>
</HTML>

116
welcome/index.html Normal file
View File

@ -0,0 +1,116 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>The Index</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br>
<h2>The Index</h2>
<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>
<br>
<h3>Indexing commands in Terminal</h3>
<p>There are several commands to manage the index:
<ul>
<li><b>lsindex</b> - Displays the indexed attributes on the current volume/partition.
<p>These are the attributes that are indexed by default:<br>
<pre>58 ~ -&gt;lsindex
BEOS:APP_SIG
MAIL:account
MAIL:cc
MAIL:chain
MAIL:draft
MAIL:flags
MAIL:from
MAIL:name
MAIL:pending_chain
MAIL:priority
MAIL:reply
MAIL:status
MAIL:subject
MAIL:thread
MAIL:to
MAIL:when
META:address
META:city
META:company
META:country
META:email
META:fax
META:group
META:hphone
META:name
META:nickname
META:state
META:url
META:wphone
META:zip
_signature
_status
_trk/qrylastchange
_trk/recentQuery
be:deskbar_item_status
last_modified
name
size
</pre></p></li>
<li><b>mkindex</b> - Adds an attribute to the index of a volume/partition.
<pre>Usage: mkindex [options] &lt;attribute&gt;
Creates a new index for the specified attribute.
-d, --volume=PATH a path on the volume to which the index will be added,
defaults to current volume.
-t, --type=TYPE the type of the attribute being indexed. One of &quot;int&quot;,
&quot;llong&quot;, &quot;string&quot;, &quot;float&quot;, or &quot;double&quot;.
Defaults to &quot;string&quot;.
--copy-from path to volume to copy the indexes from.
-v, --verbose print information about the index being created
</pre>
<p><i><b>Note:</b> Only <b>new</b> files with that attribute come automatically into the index!</i><br>
Existing files have to be added manually by copying them and deleting the originals after that. Alternatively you can use the tool <a href="http://www.bebits.com/app/2033" rel="nofollow">reindex</a>.
</p>
</li>
<li><b>rmindex</b> - Removes an attribute from the index of a volume/partition.
<pre>Usage: rmindex [OPTION]... INDEX_NAME
Removes the index named INDEX_NAME from a disk volume. Once this has been
done, it will no longer be possible to use the query system to search for
files with the INDEX_NAME attribute.
-d, --volume=PATH a path on the volume from which the index will be
removed
-h, --help display this help and exit
-p, --pattern INDEX_NAME is a pattern
-v, --verbose print information about the index being removed
INDEX_NAME is the name of a file attribute.
If no volume is specified, the volume of the current directory is assumed.</pre>
</ul>
</TD></TR>
</TABLE>
</BODY>
</HTML>

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

117
welcome/queries.html Normal file
View File

@ -0,0 +1,117 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Queries</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br><br>
<h2>Queries</h2>
<p>A query is a file search based on file attributes and can be performed within Tracker or in Terminal. Queries are saved in "<tt>/boot/home/queries</tt>" and by default last seven days before being purged. Note, that these aren't static result list of your search, but are the query formulas which trigger a new search whenever you open them.
</p>
<br>
<h3>The Find window</h3>
<p>You start a query by invoking the <i>Find...</i> menu either from the Deskbar menu or any Tracker window or the Desktop (which is actually a fullscreen Tracker window). The shortcut is <tt>ALT+F</tt>. You're presented with the Find window:
<br>
<br>
<img src="queries-images/basic-query.png" alt="basic-query.png" width="517" height="292">
<br>
</p><p>[1] Select previous or saved queries or save the current query.<br />
[2] Narrow down your search from "All files and folders" to specific file
types.<br />
[3] Define the search method:<ul>
<li><i>by Name</i> - a basic search by filename</li>
<li><i>by Attribute</i> - an advanced search, you specify search terms for one or more attributes</li>
<li><i>by Formula</i> - an even more advanced search, you can fine-tune a complex query term</li></ul>
[4] Select which drives to search on.<br />
[5] Enter the search term.<br />
[6] The expander hides/unhides the additional options.<br />
[7] Uncheck the <i> Temporary</i> checkbox if you don't want this query self-destruct after 7 days.<br />
[8] Check if your query is supposed to <i>Include trash</i>.<br />
[9] Optionally, enter a name for this query if you want to save it.<br />
[10] You can drag&amp;drop the icon to save the query.
</p><p><br />
</p>
<h3>Basic queries - "by Name"</h3>
<p>If you simply want to find all files on your mounted disks that match a certain pattern, simply leave the search method at "<i>by Name</i>", enter the search term into the text box and press <tt>ENTER</tt>.
</p><p><br />
</p>
<h3>Advanced queries - "by Attribute"</h3>
<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 indexed (see <a href="index.html">Index</a>).
<br>
<br>
<img src="queries-images/query-window.png" alt="query-window.png" width="441" height="172">
<br>
</p><p>You start by setting the filetype from "<i>All files and folders</i>" to "<i>text | E-mail</i>" and change the search method to "<i>by Attribute</i>.
</p><p>This adds a dropdown menu to the left of the textbox and the buttons "<i>Add</i> and <i>Remove</i> under that. From the menu you choose which attribute to query. With "<i>Add</i> and <i>Remove</i> you can query additional attributes or remove them again. These attributes can be logically linked with AND/OR.
</p><p>Let's do an email query as an example:
<br>
<br>
<img src="queries-images/query-window-filled.png" alt="query-winsow-filled.png" width="441" height="262"<br>
</p><p>This is your Find window when you're looking for all emails Clara Botter has sent to you in the last two months that had in the subject "vibraphone" or "skepticality".
</p><p><br />
</p>
<h3>Even more advanced queries - "by Formula"</h3>
<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
"<i>by Formula</i> mode and be overwhelmed by this one line query string:
<br>
<img src="queries-images/formula-query.png" alt="formula-query.png" width="441" height="173">
<br>
</p><p>Once more as text, edited for readability:
</p>
<pre>(((((MAIL:from==&quot;*[cC][lL][aA][rR][aA] [bB][oO][tT][tT][eE][rR][sS]*&quot;)
&amp;&amp;(MAIL:when&gt;=%2 months%))
&amp;&amp;(MAIL:subject==&quot;*[vV][iI][bB][rR][aA][pP][hH][oO][nN][eE]*&quot;))
||(MAIL:subject==&quot;*[sS][kK][eE][pP][tT][iI][cC][aA][lL][iI][tT][yY]*&quot;))
&amp;&amp;(BEOS:TYPE==&quot;text/x-email&quot;))</pre>
<p>What's the use?
</p>
<ul>
<li>You could copy and paste the string into an email, forum or IRC for others to use or debug.</li>
<li>You can use this method to construct a query in "<i>Attribute</i> mode and then switch to "<i>Formula</i> mode, to comfortably generate a search string to use for a query in Terminal or a script.</li>
<li>You can fine tune your query by inserting paranthesis where needed, make parts case-sensitive or negate logical combinations by changing. e.g. "<tt>==</tt>" to "<tt>!=</tt>" for a NOT AND. All you need is a basic understanding of <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> and maybe some scripting basics.</li>
</ul>
<p><br />
</p>
<h3>The result window</h3>
<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><p><img src="queries-images/result-window.png" alt="result-window.png" width="704" height="359">
</p><p>Besides the grey backgound, result windows work exactly like any other Tracker window. Some things are worth noting:
</p>
<ul>
<li>You can open the folder a file resides in by double clicking on its path attribute.</li>
<li>With <i>File | Edit Query</i> or <tt>ALT+G</tt> you get back to your Find window to refine your query.</li>
<li>A query is live, i.e. if a file that matches your search criteria appears or disappears from your system, this change is reflected in your resuls in
realtime.
</ul>
<p>You can assign a sensible attribute layout for query results of a specific filetype. Open the folder containing files of the filetype you'd like to create a template for and arrange the attributes how you'd like to have query results presented. Copy this layout with <i>Attributes | Copy Attributes</i>.
</p><p>Open <tt>/boot/home/config/settings/Tracker/DefaultQueryTemplates</tt>, create a new folder and rename it to <i>group/filetype</i>, replacing slashes with underscores, e.g."audio_x-mp3".
Open the new folder and paste in the layout with <i>Attributes | Paste Attributes</i>.
</p>
</TD></TR>
</TABLE>
</BODY>
</HTML>

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

118
welcome/tracker.html Normal file
View File

@ -0,0 +1,118 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>The Tracker</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br><br>
<h2><a name="tracker">The Tracker</a></h2>
<p>The Tracker is the graphical interface to all your files. It let's you create new files and folders or find, launch or rename as well as copy or delete existing ones.
</p><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 e.g. crashed or frozen Tracker is to call the TeamManager with <tt>CTRL+ALT+DEL</tt> to kill Tracker and then click the <i>Restart Desktop...</i> button. The same brings back a wayward Deskbar.
</p>
<br>
<h3><a name="mounting-volumes">Mounting Volumes</a></h3>
<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 <i>Mount</i> submenu.
</p>
<img src="tracker-images/mount-settings.png" alt="drill-down.png" width="581" height="290">
<br>
</p><p>There are also <i>Mount Settings</i> so you don't have to mount everything manually on every bootup.<br>
The above setting will mount all disks on bootup that were mounted previously and will automatically mount any storage device you connect/insert.
</p><p><b><font size="+1" color="#FF0000">Warning:</font><br>
<font color="#FF0000">Before you disconnect e.g. a harddrive or USB stick, make sure you have successfully unmounted the volume. This garantees that all data transfer has finished. Otherwise you may lose data or corrupt the disk!</font></b>
</p><br>
<h3><a name="navigating">Navigating</a></h3>
<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><p>Instead of double-clicking your way down folder after folder, there's a better way to drill down:
</p>
<img src="tracker-images/drill-down.png" alt="drill-down.png" width="603" height="303">
<br>
</p><p>Right-click onto a folder, and at the top of the usual context menu you'll find a submenu of the current folder that let's you navigate down a level. Just move down the hierarchy until you find the file or folder you're looking for and click on it to open it. The above shows the contents of the folder <tt>/boot/beos/system/</tt>.
<br><br>
</p>A similar method can be used from any Tracker window:<p>
</p>
<img src="tracker-images/window-drill-down.png" alt="window-drill-down.png" width="502" height="359">
<br>
</p>Click on the area in the lower left, where the number of items are listed, and you'll get submenus for every level above you current folder. From there you can drill down through the folders as usual.
</p><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>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 left <tt>WIN</tt> key, which automatically closes the parent window.<br>
This is also true for...</p>
<h4><a name="keyboard-navigation">Keyboard navigation</a></h4>
<p>A few shortcuts are essential for keyboard navigation:
<ul><li><tt>ALT+CURSOR-UP</tt> - Open parent folder.</li>
<li><tt>ALT+CURSOR-DOWN</tt> or <tt>RETURN</tt> - Open selected folder.</li>
<li><tt>ALT+W</tt> - Close window.</li>
<li><tt>ALT+ESC</tt> - Enter menu bar (leave with <tt>ESC</tt>).</li>
<li><tt>right MENU-KEY</tt> - Open Deskbar menu (leave with <tt>ESC</tt>).</li></ul>
</p>
<br>
<h3><a name="appearance">Appearance</a></h3>
<img src="tracker-images/window-menu.png" alt="window-menu.png" width="382" height="259">
<br>
<p>Tracker windows offer three different viewing modes from the <i>Window</i> menu:
<ul><li><b>Icon View</b> (<tt>ALT+1</tt>) - Big icons, you can change the size from the submenu.</li>
<li><b>Mini Icon View</b> (<tt>ALT+2</tt>) - Small icons.</li>
<li><b>List View</b> (<tt>ALT+3</tt>) - A detailed list of your files enabling you to show/hide available attributes.</li></ul>
</p><p>The <i>Window</i> menu offers a number of other functions:
<ul><li><b>Resize Window</b> (<tt>ALT+Y</tt>) - Resizes the window to its ideal size</li>
<li><b>Clean Up</b> (<tt>ALT+K</tt>) - Aligns all icons to an invisible grid. Hold down <tt>SHIFT</tt> and the menu becomes <i>Clean Up All</i> which additionally sorts all icons alphabetically.</li>
<li><b>Select...</b> (<tt>SHIFT+ALT+A</tt>) - Select files according to a regular expression.</li>
</ul>
</p><p>The rest of the functions are pretty self-explanatory, leaving the...
</p>
<br>
<h4><a name="tracker-preferences">Tracker preferences</a></h4>
<p><i>Window | Preferences...</i> opens a panel that offers a number of setting that, where not obvious, should become clear once tried out. Since all settings a re applied live, you'll immediately see the changes.
<br>So, in short, the not so obvious settings:
<ul><li><b>Desktop</b> - Decide if all mounted disks appear directly on the Desktop or in a window after clicking a single Disk icon sitting on the Desktop.</li>
<li><b>Windows</b> - You can set <i>Single Window Navigation</i>, i.e. a double-clicked folder doesn't open in its own window, but inside its parent instead. This is not the same as clicking while holding the <tt>WIN</tt> key, as described above, because you'll lose the per window saved position and size.
<br>
<img src="tracker-images/tracker-preferences-navigator.png" alt="tracker-preferences-navigator.png" width="608" height="413">
<p>
On the other hand, single window browsing offers a <i>Navigator</i> where you can enter or copy&paste a path name and use back, forward and up buttons.</p></li>
<li><b>Date and Time</b> - Set date and time formats.</li>
<li><b>Trash</b> - Set the behaviour when deleting a file.</li>
<li><b>Volume Icons</b> - Set the colour of an optional indicator of free space that's shown besides a disk's icon.</li>
</ul>
</p>
<br>
<h3>Working with files</h3>
<p>When invoked on a selected file, the <i>File</i> menu offers about the same options as when you open a context menu by right-clicking the file. Exceptions are commands that don't specifically target a selected file, like <i>Find..</i> or <i>New...</i>.
</p><p>As usual the usage of the commands is pretty clear, so we'll concentrate on the niftier parts.</p>
<ul><li><b>Find...</b> - Find a file or folder. See topic <a href="Query.html">Query</a> for more info.</li>
<li><b>New...</b> - Create a new folder or any other file after a template.
<br><br>
<img src="tracker-images/new-menu.png" alt="new-menu.png" width="627" height="219">
<p>Choosing <i>Edit Templates...</i> opens the folder <tt>/boot/home/config/settings/Tracker/Tracker New Templates</tt>. Creating a file in that folder will offer its filetype with the file's name and other attributes as template in the <i>New...</i> menu. Here, there's a file "Text" with the filetype <tt>text/plain</tt>. See topic <a href="filetypes.html">Filetypes</a> for more info.</p></li>
<li><b>Open With...</b> - A submenu offers all applications that can handle this filetype.
<br><br>
<img src="tracker-images/open-with.png" alt="open-with.png" width="295" height="215">
<p>The preferred application that would open the file when double-clicked, is checkmarked. In this submenu are only those applications listed that deal with the exact filetype, in this case it's a text file, the type <tt>text/plain</tt>. If you don't click on an app in the submenu, but on <i>Open With...</i> a panel opens:
<br><br>
<img src="tracker-images/open-with-preferred.png" alt="open-with-preferred" width="627" height="219">
<p>
</TD></TR>
</TABLE>
</BODY>
</HTML>

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

39
welcome/twitcher.html Normal file
View File

@ -0,0 +1,39 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>The Twitcher</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br>
<h2>The Twitcher</h2>
<p>The Twitcher is a task switcher to jump between running applications and their windows.</p>
<p>
<img src="twitcher-images/twitcher.png" alt="twitcher.png" width="284" height="96">
</p>
<p>Just tap <tt>CTRL+TAB</tt> quickly to switch between the current and the last application/window. Or press <tt>CTRL+TAB</tt> and hold the <tt>CTRL</tt> key to go through all running applications by repeatedly hitting <tt>TAB</tt> or <tt>CURSOR LEFT/RIGHT</tt>. If you need to get to a specific window of a program, move to its icon as described and then go through its open windows with the <tt>CURSOR UP/DOWN</tt> keys.
</p><p>It's also possible to invoke the Twitcher with <tt>CTRL+TAB</tt> and then use the mouse to choose the application/window you'll jump to when releasing the <tt>CTRL</tt> key.
</p>
</TD></TR>
</TABLE>
</BODY>
</HTML>

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

89
welcome/welcome.html Normal file
View File

@ -0,0 +1,89 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Welcome to Haiku!</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br><br>
<H2><a name="welcome">Welcome to Haiku</a></H2>
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.<br>
This alpha release doesn't yet offer all the features and well-rounded end-user experience planned for the final R1 version. It's only the first step to get there and is therefore addressing foremost developers that want to have a look or help out.
<br><br><br>
<H2><a name="system">Getting to know the system</a></H2>
The first release(s) of Haiku will be very much like the BeOS R5, the OS it is reimplementing.<br>
If you never experienced it, there are a few short introductions to some of its features:
<UL>
<LI>Filesystem layout</LI>
<LI><a href="gui.html">Haiku's GUI</a></LI>
<LI><a href="workspaces.html">Workspaces</a></LI>
<LI><a href="twitcher.html">Twitcher</a></LI>
<LI><a href="tracker.html">Tracker</a></LI>
<LI><a href="deskbar.html">Deskbar</a></LI>
<LI><a href="filetypes.html">Filetypes</a> (plus <a href="workshop-filetypes+attributes.html">Workshop</a>)</LI>
<LI><a href="attributes.html">Attributes</a></LI>
<LI><a href="index.html">Index</a></LI>
<LI><a href="queries.html">Queries</a></LI>
</UL>
<br><br>
<H2><a name="api">Getting to know the API</a></H2>
Since Haiku is a reimplementation, the API is still the same as for BeOS R5 for the most part. 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.<br>
There are additional resources that should help you getting started:
<UL>
<LI><a href="http://www.haiku-os.org/development/faq">Development FAQ (online)</a>
</LI>
<LI><a href="http://dev.haiku-os.org/browser/">Source Browser (online)</a>
</LI>
<LI><a href="http://www.haiku-os.org/legacy-docs/bebook/">BeBook (online)</a>
</LI>
<LI><a href="http://www.haiku-os.org/legacy-docs/benewsletter/">BeNewsletter Archive (online) </a>
</LI>
</UL>
<br><br>
<H2><a name="bugreport">Reporting bugs</a></H2>
The main reason for releasing an alpha version is to get more people to test the system and discover bugs or provide suggestions for future enhancements. Please file bugs and enhancements in our bug tracker after using its search function to avoid duplicates.
<UL>
<LI><a href="http://dev.haiku-os.org/wiki">Haiku Bug Tracker</a></LI>
<LI><a href="bugreports.html">Tips for a helpful bug report</a></LI>
</UL>
<br><br>
<H2><a name="contact">Getting in contact</a></H2>
Get in contact with other developers and users and join the discussions in our forums or mailing lists.
<UL>
<LI><a href="http://www.haiku-os.org/forum">Haiku Forums</a></LI>
<LI><a href="http://www.freelists.org/list/openbeos">General mailing list</a></LI>
<LI><a href="http://www.freelists.org/list/haiku-development">Development mailing list</a></LI>
<LI><a href="http://www.haiku-os.org/community/ml">Overview</a> of more specific mailing lists</LI>
</UL>
<br><br>
<H2><a name="software">3rd party software</a></H2>
Because of our binary and source compatibility to BeOS, many applications still run on Haiku. After downloading a package, simply unzip it to a folder in <tt>/boot/apps/</tt> and start the binary from there.<br>
Popular software repositories are:
<UL>
<LI><a href="http://www.haikuware.com">Haikuware</a></LI>
<LI><a href="http://www.bebits.com">BeBits</a></LI>
<LI><a href="http://ports.haiku-files.org/">HaikuPorts</a></LI>
</UL>
</TD></TR>
</TABLE>
</BODY>
</HTML>

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

View File

@ -0,0 +1,157 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Workshop: Filetypes & Attributes</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br>
<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>
<br>
<h2><a name="preparations">Preparations</a></h2>
<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' <i>NetPositiv</i> 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 (</>/= vs. is/contains/starts with).
</p>
<p>Here's are the attributes I'd like to see for my DVDs:
<ul>
<li>Movie title</li>
<li>Genre</li>
<li>URL to e.g. IMdB</li>
<li>Director/Cast</li>
<li>Plot</li>
<li>My rating from 1 to 10</li>
<li>Coordinates in my shelf, e.g. A2, B3, so I find the DVD also in Real Life :)</li>
<li>If so, who's borrowed the disk...</li>
</ul>
</p>
<h2><a name="custom-filetype">Creating a custom filetype</a></h2>
<p>Start the <i>Filetypes</i> preferences, and click on the <i>Add...</i> 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><p>
<img src="workshop-filetypes+attributes-images/filetypes-new-file-type.png" alt="filetypes-new-file-type.png" width="559" height="432">
</p>
<p>Now, a panel for your new DVDdb filetype opens:
</p><p>
<img src="workshop-filetypes+attributes-images/filetypes-dvddb.png" alt="filetypes-dvddb.png" width="559" height="432">
</p>
<h3><a name="icon">Icon</a></h3>
<p>Double-click the icon well to open <i>Icon-O-Matic</i> 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.
</p>
<h3><a name="file-recognition">File Recognition</a></h3>
<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>
<h3><a name="decription">Description</a></h3>
<p><ul>
<li><i>Type Name</i> - Appears e.g. in the Attribute menu of Tracker windows and the "Kind" attribute of a file.</li>
<li><i>Description</i> - A bit more detailed description.</li>
</ul>
</p>
<h3><a name="pref_app">Preferred Application</a></h3>
<p>This dropdown 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><p>
<i>Select...</i> opens a file dialog where you choose the application to open with this filetype. Here, we set <i>Showimage</i> to display the DVD's cover.
<i>Same as...</i> opens a file dialog where you choose any file that already has the preferred application set that you're looking for.
</p>
<h3><a name="extra_attribute">Extra Attributes</a></h3>
<p>Here we enter all the custom attributes we decided on in our preparations. Clicking the <i>Add...</i> button opens a panel:
</p><p>
<img src="workshop-filetypes+attributes-images/filetype-extra-attribute.png" alt="filetype-extra-attribute.png" width="614" height="447">
</p>
<p><ul><li><i>Attribute Name</i> - Appears e.g. as the column heading in Tracker windows.</li>
<li><i>Internal Name</i> - Is used for indexing and querying the attribute.</li>
<li><i>Type</i> - Defines the value the attribute can hold and therefore how it can be queried.<ul>
<li><i>String</i> for normal text</li>
<li><i>Boolean</i> for binary data: 0 or 1</li>
<li><i>Integer</i> for integer numbers with different ranges:<ul>
<li><i>8 bit</i>: +- 255</li>
<li><i>16 bit</i>: +- 65,535</li>
<li><i>32 bit</i>: +- 4,294,967,295</li>
<li><i>64 bit</i>: +- 18,446,744,073,709,551,615</li></ul></li>
<li><i>Float</i> for floatingpoint numbers, single precision</li>
<li><i>Double</i> for floatingpoint numbers, double precision</li>
<li><i>Time</i> for time and date format</li>
</ul>
<li><i>Visible</i> - This checkbox determines if the attribute is visible in a Tracker window at all. Since the Tracker will be the interface to our DVD database, we check it and define its appearance with:<ul>
<li><i>Display As</i> - Leave on "Default". In the future more option will become available, e.g. a bar or stars for a rating etc.</li>
<li><i>Editable</i> - Determines if the attribute shall be editable in Tracker.</li>
<li><i>Width</i> - The default width of that attributes column in a Tracker window.</li>
<li><i>Alignment</i> - The attribute can be displayed left, center, or right aligned.</li>
</ul></li></ul>
</p><p>Now, insert all the info for our attributes:</p>
<p><table cellpadding=10 border=1>
<th>Internal Name</th><th>Attribute type</th><th>indexed?</th><th>Description</th>
<tr>
<td>DVDdb:title</td> <td>text</td> <td>yes</td> <td>Movie title</td></tr>
<td>DVDdb:genre</td> <td>text</td> <td>yes</td> <td>Genre</td></tr>
<td>DVDdb:url</td> <td>text</td> <td>no</td> <td>URL</td></tr>
<td>DVDdb:cast</td> <td>text</td> <td>yes</td> <td>Director/Cast</td></tr>
<td>DVDdb:plot</td> <td>text</td> <td>no</td> <td>Plot</td></tr>
<td>DVDdb:rating</td> <td>int-32</td> <td>yes</td> <td>Rating 1 to 10</td></tr>
<td>DVDdb:coord</td> <td>text</td> <td>no</td> <td>Shelf</td></tr>
<td>DVDdb:lent</td> <td>text</td> <td>yes</td> <td>Lent to</td></tr>
</table>
</p>
<h2><a name="indexing">Indexing</a></h2>
<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 Haikus fast <a href="queries.html">Queries</a>.
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><p>This leaves these attributes:
</p><p>
<table cellpadding=10 border=1>
<th>Internal Name</th><th>Attribute type</th>
<tr>
<td>DVDdb:title</td> <td>text</td> </tr>
<td>DVDdb:genre</td> <td>text</td> </tr>
<td>DVDdb:cast</td> <td>text</td> </tr>
<td>DVDdb:rating</td> <td>int-32</td> </td></tr>
</table>
</p><p>To index them, we open a Terminal and simply add one attribute after the other:
<pre>mkindex -t string DVDdb:title
mkindex -t string DVDdb:genre
mkindex -t string DVDdb:cast
mkindex -t int DVDdb:rating</pre>
</p><p>The <tt>-t</tt> option defines the type of attribute, which is "string" for all but the rating, which is an integer number.
</p>
<h2><a name="filling-data">Filling in the data</a></h2>
</p><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><p>Opening that folder we see a typical Tracker window with one JPEG in it. Right-clicking it, we change its filetype to <tt>application/DVDdb</tt> with the <i>Filetype Addon</i>. There's more info on this in the <a href="filetypes.html">Filetypes</a> document.
</p><p>Now, we activate all our DVDdb attributes from the <i>Attributes</i> menu of the Tracker window and rearrange the columns to our taste:
</p><p>
<img src="workshop-filetypes+attributes-images/filetypes-dvddb-empty.png" alt="filetypes-dvddb-empty.png" width="861" height="257">
</p><p>By clicking on a yet empty attribute (or pressing <tt>ALT+E</tt>) we enter editing mode and fill each attribute. With <tt>TAB</tt> and <tt>SHIFT+TAB</tt> you can navigate between attributes.
</p><p>In our example, we usually start with a downloaded JPG cover and change its type to applications/DVDdb. There's another elegant way to produce a file to work with.
Just copy an empty file of our filetype to <tt>/boot/home/config/settings/Tracker/Tracker New Templates</tt> and rename it to DVDdb.
</p><p>Right-clicking into a Tracker window, you'll find a new entry under <i>New...</i> besides the default "New folder".
</p>
<h2><a name="query-db">Querying the database</a></h2>
</p><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>
Open the folder containing your DVDdb files and arrange the attributes how you'd like to have query results presented. Copy this layout with <i>Attributes | Copy Attributes</i>.
</p><p>Open <tt>/boot/home/config/settings/Tracker/DefaultQueryTemplates</tt>, create a new folder and rename it to <i>group/filetype</i>, replacing slashes with underscores; in our case "applications_DVDdb".
</p><p>Open the new folder and paste in the layout with <i>Attributes | Paste Attributes</i>. Voilà:
</p><p>
<img src="workshop-filetypes+attributes-images/query-dvddb.png" alt="query-dvddb.png" width="757" height="462">
</p>
</TD></TR>
</TABLE>
</BODY>
</HTML>

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

46
welcome/workspaces.html Normal file
View File

@ -0,0 +1,46 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
<TITLE>Workspaces</TITLE>
<META NAME="CREATED" CONTENT="0;0">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<META NAME="CHANGED" CONTENT="20080926;15151900">
<META NAME="CHANGEDBY" CONTENT="Humdinger">
<STYLE TYPE="text/css">
</STYLE>
</HEAD>
<BODY LANG="en-US">
<TABLE WIDTH=100% BORDER=0 CELLPADDING=0 CELLSPACING=0>
<COL WIDTH=256*>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#326496">
<P STYLE="background: #326496"><a href="welcome.html"><img src="welcome-images/shijin-logo.png" alt="Logo" border="0"></a></p>
</TD>
</TR>
<TR>
<TD WIDTH=100% VALIGN=TOP BGCOLOR="#204f7e">
<P STYLE="background: #204f7e"><img src="welcome-images/dummy.png" alt="dummy"></p>
</TD>
</TR>
<TR><TD WIDTH=100% VALIGN=TOP>
<br>
<h2>Workspaces</h2>
<p>Workspaces are virtual desktops, complete with their own resolution, colour depth and background. Up to 32 of these workspaces can be set from the <i>Screen</i> preferences.
</p>
<br>
<h3>The Workspaces Applet</h3>
<p><img src="workspaces-images/workspaces.png" alt="workspaces.png" width="404" height="200">
</p><p>The Workspaces applet shows a miniature version of all workspaces. There are several options available from the context menu of the applet's window, which are all pretty self-explaining. 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 "<i>Show Replicants</i>" is activated in the Deskbar menu).</p>
<br>
<h3>Switching workspaces</h3>
<p>You can switch between workspaces by either clicking into the Workspaces applet or by using the keyboard shortcut ALT+Fx, where "x" is the workspace number. Also, clicking on an application or one of its windows in the Deskbar will send you to the workspace it resides in.
</p>
<br>
<h3>Moving windows between workspaces</h3>
<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 on 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.
</p>
</TD></TR>
</TABLE>
</BODY>
</HTML>