diff --git a/docs/welcome/attributes-images/people.png b/docs/welcome/attributes-images/people.png new file mode 100644 index 0000000000..40a2e51613 Binary files /dev/null and b/docs/welcome/attributes-images/people.png differ diff --git a/docs/welcome/attributes.html b/docs/welcome/attributes.html new file mode 100644 index 0000000000..37b37af449 --- /dev/null +++ b/docs/welcome/attributes.html @@ -0,0 +1,138 @@ + + +
+ +| + + | +
|
+
|
+
|
+ + Attributes+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. + 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. + The file itself doesn't even need any contents at all. Take a look at these People files for example: + +
+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. + If you index these attributes, as People, Email or audio files are by default, they are also searchable with Haiku's fast query system. + ++ Attributes in Tracker+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. + To do this, open a Tracker window, click on the Attributes 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&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. + Double-click on the line between two attributes in the heading to automatically resize a column to its optimal width. + Click on a column heading to toggle the sorting order from ascending to descending. You can establish a secondary sort order by pressing the SHIFT 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. + Editing these attributes is as simple as renaming a file: Either click on an entry or press ALT+E and move between the attibutes with TAB and SHIFT+TAB. ESC leaves the editing mode without applying the changes. + ++ Attributes in Terminal+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: + +
|
| + + | +
|
+
|
+
|
+ + Reporting bugs+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.
+ |
| + + | +
|
+
|
+
|
+ + The Deskbar+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. + +
++ 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&drop it into the new position. You can also fold it into a more compact layout by drag&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. + + The Deskbar Menu+A menu opens when you click on the Deskbar's uppermost part:
+
+ Configure Deskbar Menu...+
+ In this panel you set how many recent documents, folders and applications are shown in the Deskbar, or if you show them at all. + 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 /boot/home/config/be. You can just as well link or copy files and folders directly in Tracker to configure your Deskbar. +
The Tray+
+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 Time 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. + 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. ProcessController is another example that uses its icon in the tray to provide information (CPU/memory usage) and to offer a context menu. +
The list of running programs+
+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. + If you activated Expanders in the Deskbar settings, you can show/hide the list of windows directly under an application's entry. + 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. + + |
| + + | +
|
+
|
+
|
+ + Filetypes+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. ++ Setting the filetype of a specific file+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. + +
++ The File Type+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: +
The Preferred Application+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. +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. + +The Icon+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 Filetype Add-On 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 Icon-O-Matic. ++ Global settings with the Filetypes Preferences+The Filetypes 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. +All filetypes and their configurations are stored in /boot/home/config/settings/beos_mime. Before you start experimenting, it may be prudent to make a backup of that folder... +To learn more about the Filetypes preferences see the workshop: DVDdb (Filetypes & Attributes). ++ Special settings for applications+If you invoke the Filetype Add-On on an executable (here: StyledEdit), you'll get a different dialog: +
++ 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. +Below it are several flags, controlling the app's behaviour: +
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 Open with... context menu when you right-click on a file of that type. +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. + |
| + + | +
|
+
|
+
|
+ + Haiku's GUI+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. + 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. ++ 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 CTRL key, but ALT 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. ALT+C and ALT+V is reached more conveniently on the keyboard and these commands seemlessly integrate into the bash shell of the Terminal. + In any case, you can switch to the maybe more familiar CTRL key in the Menu preferences. + ++ ![]()
+[1] The Deskbar is Haiku's "Start" menu and taskbar, if you will. See topic Deskbar.
+[4] The maximise button. +[5] The resize button. Dragging anywhere else on a window's border will move the window. + That's pretty much all there is to Haiku's GUI widgets in general. You'll find more information in Getting to know the system. + + |
| + + | +
|
+
|
+
|
+ + The Index+
+Attributes and Queries 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. + Indexing commands in Terminal+There are several commands to manage the index: +
|
| + + | +
|
+
|
+
|
+ + Queries+A query is a file search based on file attributes and can be performed within Tracker or in Terminal. Queries are saved in "/boot/home/queries" 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. + ++ The Find window+You start a query by invoking the Find... menu either from the Deskbar menu or any Tracker window or the Desktop (which is actually a fullscreen Tracker window). The shortcut is ALT+F. You're presented with the Find window:
+ [1] Select previous or saved queries or save the current query.
+[5] Enter the search term. +[6] The expander hides/unhides the additional options. +[7] Uncheck the Temporary checkbox if you don't want this query self-destruct after 7 days. +[8] Check if your query is supposed to Include trash. +[9] Optionally, enter a name for this query if you want to save it. +[10] You can drag&drop the icon to save the query. +
Basic queries - "by Name"+If you simply want to find all files on your mounted disks that match a certain pattern, simply leave the search method at "by Name", enter the search term into the text box and press ENTER. + +
Advanced queries - "by Attribute"+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 Index).
+ You start by setting the filetype from "All files and folders" to "text | E-mail" and change the search method to "by Attribute. + This adds a dropdown menu to the left of the textbox and the buttons "Add and Remove under that. From the menu you choose which attribute to query. With "Add and Remove you can query additional attributes or remove them again. These attributes can be logically linked with AND/OR. + Let's do an email query as an example:
+ 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". +
Even more advanced queries - "by Formula"+Typing in a formula query by hand is daunting and really quite unpractical. It still has its uses. + 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
+"by Formula mode and be overwhelmed by this one line query string:
+ Once more as text, edited for readability: + +(((((MAIL:from=="*[cC][lL][aA][rR][aA] [bB][oO][tT][tT][eE][rR][sS]*") + &&(MAIL:when>=%2 months%)) + &&(MAIL:subject=="*[vV][iI][bB][rR][aA][pP][hH][oO][nN][eE]*")) + ||(MAIL:subject=="*[sS][kK][eE][pP][tT][iI][cC][aA][lL][iI][tT][yY]*")) + &&(BEOS:TYPE=="text/x-email"))+ + What's the use? + +
The result window+After you start a search, the Find window will be replaced by a result window. Here is an example that queried for "server": +
Besides the grey backgound, result windows work exactly like any other Tracker window. Some things are worth noting: + +
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 Attributes | Copy Attributes. + Open /boot/home/config/settings/Tracker/DefaultQueryTemplates, create a new folder and rename it to group/filetype, replacing slashes with underscores, e.g."audio_x-mp3". +Open the new folder and paste in the layout with Attributes | Paste Attributes. + + |
| + + | +
|
+
|
+
|
+ + The Tracker+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. + 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 CTRL+ALT+DEL to kill Tracker and then click the Restart Desktop... button. The same brings back a wayward Deskbar. + ++ Mounting Volumes+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 Mount submenu. + ++ There are also Mount Settings so you don't have to mount everything manually on every bootup. Warning: + Navigating+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. + Instead of double-clicking your way down folder after folder, there's a better way to drill down: + ++ 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 /boot/beos/system/.
+ + ++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. + 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. + + 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. Keyboard navigation+A few shortcuts are essential for keyboard navigation: +
+ Appearance++ Tracker windows offer three different viewing modes from the Window menu: +
The Window menu offers a number of other functions: +
The rest of the functions are pretty self-explanatory, leaving the... + ++ Tracker preferences+Window | Preferences... 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.
+
+ Working with files+When invoked on a selected file, the File 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 Find.. or New.... + As usual the usage of the commands is pretty clear, so we'll concentrate on the niftier parts. +
|
| + + | +
|
+
|
+
|
+ + The Twitcher+The Twitcher is a task switcher to jump between running applications and their windows. +
+ Just tap CTRL+TAB quickly to switch between the current and the last application/window. Or press CTRL+TAB and hold the CTRL key to go through all running applications by repeatedly hitting TAB or CURSOR LEFT/RIGHT. 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 CURSOR UP/DOWN keys. + It's also possible to invoke the Twitcher with CTRL+TAB and then use the mouse to choose the application/window you'll jump to when releasing the CTRL key. + + |
| + + | +
|
+
|
+
|
+ + Welcome to Haiku+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.+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. + + Getting to know the system+The first release(s) of Haiku will be very much like the BeOS R5, the OS it is reimplementing.+If you never experienced it, there are a few short introductions to some of its features: +
+ Getting to know the API+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.+There are additional resources that should help you getting started: +
+ Reporting bugs+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. + ++ Getting in contact+Get in contact with other developers and users and join the discussions in our forums or mailing lists. +
+ 3rd party software+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 /boot/apps/ and start the binary from there.+Popular software repositories are: +
|
| + + | +||||||||||||||||||||||||||||||||||||||||||||||
|
+
|
+ ||||||||||||||||||||||||||||||||||||||||||||||
|
+ + This is a workshop to show the use of Attributes, Queries, the Index and custom Filetypes. As an example, we build a database to keep track of our DVD library. + ++ Preparations+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' NetPositiv at the moment, so I came up with this: The file itself will be a JPEG image for the movie cover. Here's are the attributes I'd like to see for my DVDs: +
Creating a custom filetype+Start the Filetypes preferences, and click on the Add... button below the hierarchical list on the left. A small dialog opens and you specify in which MIME Group your new filetype will reside. You can also create a completely new group. Let's put it into "applications" and set the "Internal Name" to DVDdb. +
+ Now, a panel for your new DVDdb filetype opens: +
+ Icon+Double-click the icon well to open Icon-O-Matic to design an icon for your filetype. You can also drag&drop an icon from the icon well of another type, maybe as starting point for a modified version. + +File Recognition+You can add suffixes like .txt, .jpg, .mp3 to recognize files by their extention. Useful when working with files from systems without MIME typing. We don't need that for our example. + +Description+
Preferred Application+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. + +Select... opens a file dialog where you choose the application to open with this filetype. Here, we set Showimage to display the DVD's cover. +Same as... opens a file dialog where you choose any file that already has the preferred application set that you're looking for. + +Extra Attributes+Here we enter all the custom attributes we decided on in our preparations. Clicking the Add... button opens a panel: +
+
Now, insert all the info for our attributes: +
Indexing+Before we start entering data in our little DVD database, we should add certain attributes to the Index. Only indexed attributes can use Haikus fast Queries. +So, what will we be searching in the future? We probably won't ask "What's in the B4 coordinate in my shelf?" or "Does the IMdB URL or the plot of the movie contain the word 'pope-shenooda'?". + This leaves these attributes: + +
To index them, we open a Terminal and simply add one attribute after the other: + mkindex -t string DVDdb:title +mkindex -t string DVDdb:genre +mkindex -t string DVDdb:cast +mkindex -t int DVDdb:rating+ The -t option defines the type of attribute, which is "string" for all but the rating, which is an integer number. + +Filling in the data+Now, everything's set and we can begin putting some data into our base. Opening that folder we see a typical Tracker window with one JPEG in it. Right-clicking it, we change its filetype to application/DVDdb with the Filetype Addon. There's more info on this in the Filetypes document. + Now, we activate all our DVDdb attributes from the Attributes menu of the Tracker window and rearrange the columns to our taste: +
+ By clicking on a yet empty attribute (or pressing ALT+E) we enter editing mode and fill each attribute. With TAB and SHIFT+TAB you can navigate between attributes. + 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 /boot/home/config/settings/Tracker/Tracker New Templates and rename it to DVDdb. + Right-clicking into a Tracker window, you'll find a new entry under New... besides the default "New folder". + +Querying the database+Several hours of grunt work later, we have a nice little database that you can query to find all your Christina Ricci movies that have a 7+ rating... :) + You can assign a sensible attribute layout for query results of a specific filetype. Open /boot/home/config/settings/Tracker/DefaultQueryTemplates, create a new folder and rename it to group/filetype, replacing slashes with underscores; in our case "applications_DVDdb". + Open the new folder and paste in the layout with Attributes | Paste Attributes. VoilĂ : +
+ |
| + + | +
|
+
|
+
|
+ + Workspaces+Workspaces are virtual desktops, complete with their own resolution, colour depth and background. Up to 32 of these workspaces can be set from the Screen preferences. + ++ The Workspaces Applet+
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 "Show Replicants" is activated in the Deskbar menu). ++ Switching workspaces+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. + ++ Moving windows between workspaces+To move a window, you grab it in the Workspaces applet and simply drag it to another workspace. This has the advantage, that you can move it without leaving your current desktop. Of course, that only works well when there aren't too many windows 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. + + |