Commit Graph

797 Commits

Author SHA1 Message Date
John Scipione
6a4b222bc9 Use condensed, not squished together. Better 2013-01-19 13:17:50 -05:00
John Scipione
4f7717a999 By removing the style on escapement_delta doxygen links it up which is better 2013-01-19 13:17:49 -05:00
John Scipione
27c3eae9b4 Another minor fix, style constant 2013-01-19 13:17:49 -05:00
John Scipione
0d2b04ca83 Minor update use fixed font for B_OK 2013-01-19 13:17:49 -05:00
John Scipione
05757eb6b3 Fill out BFont detailed description.
Also a bunch of cleanup including removing private method docs
and cleaning up language. BFont is pretty much completely documented
at this point.
2013-01-19 13:17:48 -05:00
John Scipione
c258d2fa0e Fill out BFont member docs 2013-01-19 13:17:47 -05:00
John Scipione
566e828c5f Add initial BFont documentation 2013-01-19 13:17:46 -05:00
John Scipione
c45e8003d3 Update font size of memberdoc tables from 13px to 14.4px 2013-01-17 18:13:05 -05:00
John Scipione
4aae53f373 Update Haiku Book CSS
* Update headers to match User Guide better for font and spacing.
* 14.4px is the default font size (matching user guide).
* because we use em's for page width this makes the text area a bit narrower.
* Make note, warning, stop, remark notifications font size smaller to make
  them stand out a bit less and better matches the User Guide.
2013-01-16 12:44:22 -05:00
John Scipione
5e6540723d Update BFilePanel docs, especially detailed description and constructor 2013-01-15 23:07:12 -05:00
François Revol
7daaf25d9c Merge branch 'master' into sam460ex 2013-01-15 07:09:10 +01:00
John Scipione
2b934bb6ae Add BFilePanel and BRefFilter documentation 2013-01-14 23:31:18 -05:00
John Scipione
ea468b9855 Add \brief tag so description appears in files table 2013-01-14 21:11:15 -05:00
John Scipione
0abbcaaa35 Update Doxyfile to 1.7.5.1 2013-01-14 20:33:50 -05:00
François Revol
0ccce7886f Merge branch 'master' into sam460ex 2012-12-27 15:50:06 +01:00
John Scipione
93ebe7637f Update BDurationFormat docs. Came for warnings, ended up fixing more. 2012-12-24 19:55:26 -05:00
John Scipione
89dfe27fc8 Update BCatalog docs to fix warnings and update.
Especially listing the status codes is useful. Some style fixes and
update \li to -.
2012-12-24 19:07:56 -05:00
John Scipione
495275e4ea Add BFileInterface class documentation 2012-12-24 18:36:55 -05:00
John Scipione
c8654dba73 Minor updates to BFileGameSound docs 2012-12-24 18:31:08 -05:00
John Scipione
939600d2ad Update SetPaused() and add IsPaused() documentation 2012-12-24 16:05:51 -05:00
John Scipione
05c71c9699 Add BFileGameSound class documentation 2012-12-24 15:42:48 -05:00
François Revol
be95f65a23 Merge branch 'master' into sam460ex 2012-12-24 01:52:39 +01:00
John Scipione
e1988c7d53 Reduce font size of code blocks to 13px 2012-12-23 12:05:03 -05:00
John Scipione
e9191cc2d1 Add BFile documentation to the Haiku Book.
Remove the documentation from the cpp file also. Keep the brief
description as a regular comment though.
2012-12-22 15:01:17 -05:00
John Scipione
8e7094494a Fix another warning in MimeType.dox along with some 80 char fixes 2012-12-22 15:01:17 -05:00
John Scipione
268177055e Fix 2 warnings in MimeType.dox 2012-12-21 22:51:19 -05:00
John Scipione
f729cb8d48 Remove methods from CheckBox.dox that are not unique to the class fixing warnings 2012-12-21 22:51:19 -05:00
John Scipione
177942adc7 Remove documentation fro Button.dox that is not unique to BButton fixing a few warnings 2012-12-21 22:51:18 -05:00
John Scipione
e5f2a41917 Update revision, this matters because I changed the variables in the BDragger constructor. 2012-12-21 22:34:27 -05:00
John Scipione
a6ada82b00 Add BDragger class documentation 2012-12-21 22:31:29 -05:00
John Scipione
ceaf7141fa BDirectWindow class documentation fixes 2012-12-21 21:01:40 -05:00
John Scipione
b1b809ef27 Add preliminary DirectWindow documentation 2012-12-21 20:38:18 -05:00
John Scipione
746abcb938 Add BCursor class documentation 2012-12-21 18:26:29 -05:00
François Revol
0e4a0c0e7f sam460ex: one more address in the notes 2012-12-19 16:08:49 +01:00
François Revol
6ccf5f95c0 sam460ex: add port notes (org-mode format) 2012-12-19 15:34:23 +01:00
Przemysław Buczkowski
46cf7a5a73 Fix typos: super block -> superblock (#8974)
Signed-off-by: Przemysław Buczkowski <przemub@yahoo.pl>
Signed-off-by: Matt Madia <mattmadia@gmail.com>
2012-12-09 08:47:46 -05:00
Ithamar R. Adema
0f16abe379 Update todo notes 2012-11-22 21:30:54 +01:00
Niels Sascha Reedijk
2df12e67c1 Sync userguide from i18n.haiku-os.org. 2012-11-15 22:36:54 +01:00
Ithamar R. Adema
6645e68bb0 ARM: add todo note about VM implementation
Signed-off-by: Ithamar R. Adema <ithamar@upgrade-android.com>
2012-11-13 12:12:23 +01:00
Humdinger
d3f77ddee3 Added correct flags for Hungarian and Brazilian.
+alpha4 (just in case its rebuild...)
2012-11-08 20:05:45 +01:00
Rene Gollent
2862f14d68 Added todo list.
Lists missing/incomplete Debugger features. Not exhaustive.
2012-11-07 23:18:23 +01:00
Ithamar R. Adema
b0cef9d956 ARM/docs: add a TODO with the major open issues for this port.
Personally I find KDL hangman the biggest blocker, but oh well...
2012-11-07 17:20:47 +01:00
Ithamar R. Adema
9f512d6188 document architectural limitations of ARM port
Sure there are more, but this is at least a start for now ;)
2012-11-07 17:05:18 +01:00
François Revol
7c0097cb42 Even some more FDT/OF refs... 2012-11-06 20:14:55 +01:00
François Revol
6d8c8c0b32 Even more FDT references 2012-11-06 10:59:58 +01:00
François Revol
f8e10024ad Some more FDT references 2012-11-06 10:39:23 +01:00
François Revol
bc61f38130 Add some ARM references
* Actually stuff about FDT for now, also useful for other arch like PPC.
2012-11-06 10:33:07 +01:00
François Revol
35ef01c566 m68k: Add some atari references to the port docs 2012-11-05 20:58:04 +01:00
François Revol
a6e7fd728d m68k: Add some references to the port docs 2012-11-05 20:50:12 +01:00
François Revol
c2ee0abbc1 m68k: Remove one thing done from the TODO list 2012-11-05 20:50:12 +01:00
Niels Sascha Reedijk
5bde1d438b Update userguide from i18n.haiku-os.org. 2012-08-18 10:28:04 +02:00
Niels Sascha Reedijk
4b140bad0d Update the BString documentation.
* Remove the reference to BString::fPrivateData, as it currently really
   is marked as private and as such disappeared from the docs.
 * Add the various character methods that have been added in the
   previous revisions.
2012-05-12 11:54:07 +02:00
Oliver Tappe
546208a539 More catalog-related cleanup.
* rename B_TRANSLATE_CONTEXT to B_TRANSLATION_CONTEXT and
  B_TRANSLATE_WITH_CONTEXT to B_TRANSLATE_CONTEXT, squashing a TODO
* adjust all uses of both macros in Haiku's source tree
* use correct header guard for collecting/Catalog.h

The renamed macros require adjustments to all external applications
using catalogs.
2012-04-16 21:31:22 +02:00
John Scipione
12c10314f9 Remove MimeType docs from MimeType.cpp and cleanup style issues in that file. Create a MimeType.dox file and add the docs there. 2012-03-18 00:09:53 -04:00
Niels Sascha Reedijk
b39e687949 Update welcome pages from i18n.haiku-os.org 2012-02-17 20:39:23 +01:00
Niels Sascha Reedijk
4ac8d3e9e4 Update userguide from i18n.haiku-os.org 2012-01-31 11:50:22 +01:00
Niels Sascha Reedijk
c9d16a1694 Update the userguide from i18n.haiku-os.org 2012-01-02 08:17:34 +01:00
Niels Sascha Reedijk
646c788ab6 Update documentation from i18n.haiku-os.org 2012-01-02 08:16:11 +01:00
John Scipione
f969ed4153 A few formatting tweaks in the BEntry and BDirectory class documentation. 2011-12-18 21:43:22 -05:00
John Scipione
d4fa97f8f8 Moved documentation for the BEntry class into a dox file to include it into the Haiku book. 2011-12-18 21:28:55 -05:00
John Scipione
a92e17b124 Fix copyright line to Haiku, Inc. in Directory.dox and a few more small fixes. 2011-12-18 21:26:02 -05:00
John Scipione
38f6a824d2 Fix copyright line to Haiku, Inc. in GameProducer.dox 2011-12-18 21:25:31 -05:00
John Scipione
8786818cf2 Add documentation for the GameProducer class in the Game Kit.
This documentation was provided by Omri Barak, a student participating
in Google Code Initiative (GCI) 2011.

Signed off by John Scipione

Since this is the first class documented in the Game Kit I also added
a reference to the Game Kit to the API docs front page.
2011-12-18 19:42:33 -05:00
John Scipione
2ac1eb67b3 Move the doxygen documentation comments from src/kits/storage/Directory.cpp to docs/user/storage/Directory.dox and update it both the language, fix a few errors, and bring the syntax up to snuff. The documentation for the BDirectory class is now added to the Haiku Book. 2011-12-18 18:53:46 -05:00
Alex Wilson
a84e14ca84 Merge branch 'master' of git://github.com/haiku/haiku 2011-12-15 20:50:28 -07:00
Alexander von Gluck IV
157046ce4b Fix spelling mistake in user doc 2011-12-12 13:47:05 -06:00
Peter Polacik
8f03c411b0 A makefile/Jamfile engines How To added
* This document was written during GCI 2011
  by Peter Poláčik and is explaining how to use
  makefile and Jamfile engines to start and
  setup new development projects for Haiku.

Signed-off-by: Siarzhuk Zharski <zharik@gmx.li>
2011-12-10 08:31:18 +01:00
Alex Wilson
8f0b7c3fb8 Update doxygen docs for Layout, LayoutItem on invalidation. 2011-12-06 23:39:16 -07:00
Niels Sascha Reedijk
e6f22646a3 Update userguide and welcome documentation with the latest additions and translations from i18n.haiku-os.org. 2011-12-03 21:12:53 +01:00
John Scipione
2231cbd5fe Replace the US_PC_keyboard_keycodes.png image in the Keyboard special topic of the Haiku book with an optomized version saving over 100k. 2011-11-18 15:59:41 -05:00
François Revol
345c3b6c39 Some pointers about porting to iPaq devices since I have one now 2011-11-17 15:07:36 +01:00
François Revol
478dc9887e PPC: Preliminary untested boot support for Common Firmware Environment
CFE is used in the upcoming Amiga X-1000 dualcore PPC board.
* Largely inspired by the OF and U-Boot code.
* Still largely stubbed out.
* The loader builds but I don't have a machine to test it. Anyone interested?
2011-11-14 01:31:50 +01:00
Adrien Destugues
5caae4d450 Fix documentation of Collator: Greater and GreaterOrEqual are not commutative (that would mean Greater(s1, s2) is the same as
Greater(s2, s1), and adding a negation in front of them is not enough either.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43233 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-11 09:19:19 +00:00
John Scipione
f69cadd0e9 Update the BCollator class documentation to fix a number of spelling errors and make the text clearer and easier to read. Also add a bunch of details, a few warnings and notes and other small typographical changes.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43232 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-11 03:55:09 +00:00
John Scipione
a2547dba0e A few updates and corrections to the new Keyboard page in the Haiku Book. I hope I got this in time before the next scheduled build of the Haiku Book.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43231 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-11 02:38:48 +00:00
John Scipione
4466b89c65 Add a section to the Haiku Book with a very special topic, the keyboard.
This started off as just being a page to detail the key codes since I find
myself constantly referencing the BeBook page on the subject and it is
horribly broken. However, the page has grown to detail many of the keyboard
related methods and constants defined in InterfaceDefs.h as well. A very
long and detailed explanation of the key_map structure is included.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43230 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-10 08:35:38 +00:00
François Revol
561696cbfc TODO list for the m68k port, for when I fix the kernel build.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43113 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 14:51:15 +00:00
John Scipione
38a0577422 Set SORT_MEMBERS_CTORS_1ST variable to YES in the Doxyfile so that constructor and destructor methods will get sorted before member methods in class documentation files.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43099 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 09:17:38 +00:00
John Scipione
90a55c448a Copy paste mistype, B_WEEKDAY_FRIDAY instead of B_WEEKDAY_THURSDAY twice.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43097 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 08:40:28 +00:00
John Scipione
6ac7032dc6 Update the style of the Haiku Book to resemble the User Guide.
If you have never seen this before you are in for a bit of a shock.
Update the Doxyfile to 1.7.3 (the version that gets auto-generated).

Update the book.dox front page with some nice introductory text.

Add new documentation for the following classes:
BCheckBox
BClipboard
BColorControl
BControl
BEntryList
BView (preliminary)

Remove redundant documentation from src/kits/storage/EntryList.cpp

Minor documentation update for the following classes:
BAlert
BApplication
BArchivable
BBox
BButton
BCatalog
BFindDirectory
BHandler
BUnarchiver
BString

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43096 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 08:36:02 +00:00
John Scipione
740ae7fef6 Return B_ERROR if a locking error occurs in while locking the BLocale object, return B_BAD_VALUE if an ICU error occurs or the passed in value is NULL. Update BLocale API documentation to reflect this and also add some more documentation fixes. Closes #7901 pending confirmation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@43095 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-11-02 06:02:36 +00:00
Niels Sascha Reedijk
7f1880dc0e Apply patch for ticket #8008:
* Remove BNode documentation from the source code and add it to Node.dox
 * Rewrite some of the existing documents


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42986 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-29 22:02:52 +00:00
Niels Sascha Reedijk
1326b9d0b4 Apply the patch by jscipione on ticket #7994.
* Update BScreen class style and variable names
 * Remove documentation from Screen.cpp file
 * Create Screen.dox documentation file



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42984 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-29 21:51:43 +00:00
Adrien Destugues
c647837666 * Add some details on how the Locale and the formater classes relate and which
one one should use.
 * Add documentation for BDurationFormat.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42976 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-29 19:56:05 +00:00
François Revol
1ff3981e26 PPC Mac related links for porting.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42938 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-28 23:20:20 +00:00
Alex Wilson
7ab5610ba9 Update layout docs for LayoutInvalidated() changes. 2011-10-28 14:17:02 -06:00
Alex Wilson
4e0131f51b Rename BLayout::DerivedLayoutItems() to DoLayout(), which is consistent with BView::DoLayout(). Also adjusted child classes and documentation. 2011-10-28 14:16:25 -06:00
Alex Wilson
676c618ad7 Add a little info to the BLayout docs. 2011-10-28 14:16:22 -06:00
François Revol
3c6f4dd82e A description of the Atari TOS PRG file format I used to write the ldscript for the .prg bootloader at src/system/ldscripts/m68k/boot_prg_atari_m68k.ld
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42927 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-26 23:55:00 +00:00
Adrien Destugues
fd4f34da56 Remove extra parameter to function call in documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42859 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-10-16 10:02:10 +00:00
Adrien Destugues
68eccf0d5c The description for frameMoved and FrameResized was wrong. Thank Skipp_OSX for noticing.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42695 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-27 19:41:09 +00:00
Adrien Destugues
07658a130e Add some documentation for find_directory. This is very incomplete yet.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42694 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-27 09:15:50 +00:00
Adrien Destugues
d51bfbb57c Patch by John Scipione again : fix the new BIconUtils documentation.
thanks!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42609 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 21:57:31 +00:00
Adrien Destugues
a33f8fbdec Merge work by John Scipione on the Haiku Book.
* Some new classes documented
 * Screenshots for the interface kit controls
 * A lot of typo fixes
 * Some css tweaks

This has some backporting to the current version of Doxygen, since 
there are experiments to get coloring similar to the one in the Be 
Book that will hopefully be upstreamed in Doxygen.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 21:46:13 +00:00
Adrien Destugues
61a02f6d99 * Add the header file to doxygen, too
* Fix copypaste error.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42607 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 19:39:10 +00:00
Adrien Destugues
ca2c99c2ca * Add BIconUtils documentation to the Haiku Book
* Remove comments from the header itself.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42606 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 19:31:46 +00:00
Joachim Seemer
fac7d59322 Added a page on Mail and a little workshop so people can have a look and suggest improvements before putting it into the online tool. Which still has the problem of broken image upload and export of all pages...
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42603 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-08-09 16:40:03 +00:00
Joachim Seemer
7660ac681c Update user guide and welcome pages and their translations. Thanks everyone. +alpha
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42127 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-06-12 18:03:25 +00:00
Joachim Seemer
402f023740 Updated userguide and welcome pages. Thanks all translators. +alpha3
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41971 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-06-06 16:08:15 +00:00
Joachim Seemer
cbe53dacb8 Added Chinese and Russian flags. Fixes #7566. Thanks taos for noticing.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41716 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-24 18:02:15 +00:00
Joachim Seemer
fed577d81d Updated user guide plus translations. Thanks everyone. +alpha3
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41656 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-22 18:01:43 +00:00
Niels Sascha Reedijk
3d2b623f71 Update the header to reflect the height of the logo image, which is 84px instead of 86px. See the discussion on r41337 on haiku-commits.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41362 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-07 08:09:57 +00:00
Joachim Seemer
36883d1e5b Fixing some typos, found by John Scipione and some by myself.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41361 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-07 05:58:20 +00:00
Matt Madia
fa0af37702 Updated the HAIKU logo to display the registered trademark symbol.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@41337 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-05-06 00:01:40 +00:00
Joachim Seemer
897e2f47ef Manually updated pages from the translation site. Mostly to have the work of the GCI students in SVN history, as I already have a few reworked pages locally which I'd like to put on the translation site.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40889 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-03-09 17:03:28 +00:00
Jonas Sundström
7485fe842b Typo correction.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40722 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-02-27 11:17:18 +00:00
Philippe Houdoin
7f08510a9a Better to have consistent paths...
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40550 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-02-18 12:32:18 +00:00
Philippe Houdoin
a7e6888c00 Updated to reflect actual paths these days.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40549 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-02-18 12:08:31 +00:00
Alex Wilson
7e8daebe34 Fix a few typos in Locale kit documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40521 a95241bf-73f2-0310-859d-f6bbb57e9c96
2011-02-15 20:26:52 +00:00
Joachim Seemer
9639885450 Update to user guide. A few new pages and many translations by Google Code-In students. ShowImage, MediaPlayer and WebPositive are not yet ready for translation. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@40044 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-30 19:10:45 +00:00
Matt Madia
2c9a0aae32 Added some updates to hey documentation, for 1.2.6 --> 1.2.8 changes.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39737 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-05 13:05:17 +00:00
Matt Madia
b0a8d13338 Move icon_guidelines/ to docs/.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39730 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-04 20:18:59 +00:00
Joachim Seemer
bcbc6fda31 Updated user guide.
* Added Maciej Baluta's GCI work on NetworkStatus, PowerStatus and
  ProcessController with only minor changes.
* Created a page for Daniel Marth's GCI work, based on the wiki page at
  https://dev.haiku-os.org/wiki/SystemBinCommands
* Updated translations mostly for Japanese and Italian from the currently 
  running GCI tasks.

Thanks everyone!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39724 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-04 19:04:43 +00:00
Adrien Destugues
15352f8de6 Fix missing \fn.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39706 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-02 18:40:15 +00:00
Adrien Destugues
01c2a7f38f Some inprovements suggested by Stippi and tqh. Thanks!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39697 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-01 20:12:28 +00:00
Adrien Destugues
2d14fc1b97 Major improvement to the support kit introduction, done as part of gci by InsDel (Thanks!).
Again, review welcome on this in order to decide if we carry on asking students to write api reference pages.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39696 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-01 19:40:02 +00:00
Joachim Seemer
07df8bec9b Updated user guide and welcome page. Among it a new page on Web+ and translations done for Google Code-In. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39691 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-12-01 14:23:44 +00:00
Adrien Destugues
6ec25bba48 Add documentation for BBox class, done by Clark Gaebel as part of GCI 2010.
I did rework the text a little.

I would like to get some careful review for this. Nielx put out the (valid) concern that he's not confident in random students with no previous Haiku experience to write the API reference.
I'd like to know if I should put online more of these tasks, or if I should stop now because the quality is too low.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39686 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-11-30 21:06:09 +00:00
Joachim Seemer
1adf49423b Updated user guide pages.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39577 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-11-22 19:42:54 +00:00
Joachim Seemer
b57206f658 Fixed erroneously reversed translations. Looks like one always has to export the complete dataset from the translation site instead of just the changed sets ATM. Thanks Vincent for the tip.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39167 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-28 08:57:17 +00:00
Joachim Seemer
c585624fa4 Update of userguide\welcome page. Thanks translators.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39164 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-27 15:47:37 +00:00
Alex Wilson
cc19e7c0ff Add initial documentation for Layout API, not everything is documented, and it's not perfect, but its time to commit this.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39055 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-23 02:33:08 +00:00
Alex Wilson
a46d62a268 Fix some typos in archiving documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39054 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-23 01:51:37 +00:00
Oliver Tappe
b0c3ed0447 * fix a couple of typos
* removed a sentence that's no longer true

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39024 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-20 17:32:29 +00:00
Oliver Tappe
6f43fabafb * some cleanup in BLocaleRoster
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@39018 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-10-20 09:23:06 +00:00
Joachim Seemer
534a3a24cd Updating userguide and welcome page and their translations. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38690 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-09-17 13:28:39 +00:00
Adrien Destugues
0d858bd391 Add documentation for the BTimeZone class.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38130 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-16 07:23:42 +00:00
Alex Wilson
886c23bf8b Update doxygen docs for recent changes to BArchivable, also document the BArchiver and BUnarchiver classes, and add a not in compatibility.dox.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38035 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 22:09:14 +00:00
Joachim Seemer
834e58f9b7 Update of user guide and welcome page and their translations.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38032 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 17:56:45 +00:00
Adrien Destugues
7ea3a2b029 Add note about the fact that locale kit is not part of libbe
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38020 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 12:39:29 +00:00
Adrien Destugues
a8a3468a80 * Add documentation for the UnicodeChar class.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38018 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 12:33:47 +00:00
Axel Dörfler
4bfbfb4da5 * Corrected compatibility note. I wonder why I share my wisdom on the public
mailing list if I am then asked to do the work myself ;-)


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38016 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 12:00:47 +00:00
Adrien Destugues
cae874d384 * Lots of fixes and proofreading to the locale api reference
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38010 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-11 08:09:12 +00:00
Adrien Destugues
e82e8f365e * Update locale kit documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@38004 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-10 12:39:48 +00:00
Adrien Destugues
3290008f1e * Add the warning and info boxes from userguide. However, I don't know how to upload the associated images to the api
server.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37981 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-09 08:46:16 +00:00
Adrien Destugues
4db75e5128 * Fix typo pointed out by umccoullough. I should get a real keyboard.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37977 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-08 17:29:32 +00:00
Adrien Destugues
e579ff38fb * Added a note about the network libraries being incompatible with BeOS.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37976 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-08 16:20:09 +00:00
Adrien Destugues
5393193d0a * Fix some typos in the API reference for BLocale and BCatalog.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37950 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-07 14:08:05 +00:00
Adrien Destugues
0a4e27c50b * Fixed the main page entry for locale kit
* Also parse the actual code to get the methods shown in the classes, inheritance diagrams, and all that stuff
 * Add some docs on date formatting to BLocale


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37925 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-05 12:09:20 +00:00
Adrien Destugues
c6247544ed * Add the locale kit to the main page
* Complete and correct some parts of locale and catalog classes reference
 * Ensure the methods are prefixed with the class name so doxygen knows where they belong.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37898 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-04 12:01:38 +00:00
Adrien Destugues
e9fd63ec7c * Fix some outdated information in documentation files
* Add a very small part of documentation about the Locale Kit.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37873 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-03 16:02:55 +00:00
Joachim Seemer
7bff797f8a Updated user guide.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37849 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-08-02 16:51:09 +00:00
Joachim Seemer
facb1eb9ad Update of the user guide and its translations.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37659 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-21 15:52:50 +00:00
Ingo Weinhold
1a38616f35 Fixed fs_vnode_ops::create() documentation: The function shall not fail, if
the file already exists, unless O_EXCL has been specified. At least that's
how our file systems with write support implement it.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37554 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-17 16:00:48 +00:00
Ingo Weinhold
1f23605dd7 Added description for fs_volume_ops::get_vnode()'s _type and _flags
parameters.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37552 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-17 15:39:39 +00:00
Philippe Houdoin
18d844d2d9 Long forgotten update about the new vector icon added to midi endpoint under Haiku.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37528 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-15 18:34:25 +00:00
Joachim Seemer
ad5e743e2b Update to user guide and welcome page. Introducing Portuguese and Chinese. Thanks to all translators\!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37435 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-08 18:03:41 +00:00
Matt Madia
508f54795f Patch by Karvjorm : updates DiskUsage to XHTML Transistional. Fixes #6204.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37410 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-07-06 02:17:43 +00:00
Matt Madia
6c4ac6b0b1 The User Guide and Welcome now contain their own copies of images/.
* deleted the non-used docs/images/
 * updated the optional package Welcome accordingly


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@37036 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-06-06 16:38:37 +00:00
Joachim Seemer
2376416a94 The updated welcome package with all translations. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36782 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-05-09 15:52:37 +00:00
Joachim Seemer
0517ce048e The updated user guide with all translations. Thanks everyone.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36781 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-05-09 15:51:27 +00:00
Joachim Seemer
3636190576 Latest Welcome package changes for luroh's proof reading :)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36615 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-05-04 18:32:21 +00:00
Joachim Seemer
1cae99d78e Updated welcome page. Thanks to all translators.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36309 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-04-15 18:02:06 +00:00
Joachim Seemer
71b14067a1 Updated userguide. Thanks to all translators.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36308 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-04-15 18:01:21 +00:00
Philippe Houdoin
24957bd499 Fixed last places where resolv.conf was still expected under /etc, UserGuide included. Fixed authentication misspelling
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35898 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-03-18 08:48:13 +00:00
Joachim Seemer
05ece81569 Updated the translations of the user guide. Haiku-doc.css was moved into the userguide|welcome folder, the html-dtd folder was removed. Thanks to all contributers.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35764 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-03-05 07:01:38 +00:00
Niels Sascha Reedijk
ae15171716 Update the SupportDefs documentation for several changes and document the atomic_* functions.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35148 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-01-18 23:14:46 +00:00
Joachim Seemer
ee7dedc859 Initial import of the user guide translations from http://userguide.haikuzone.net. Thanks to Vincent for providing all the necessary tools and to all translators for their work so far!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35067 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-01-14 07:00:47 +00:00
Stephan Aßmus
06f34bf2d8 Applied patch by "Grey":
Entering the boot loader menu has changed/simplified while reducing the boot time by .75 seconds.
Now it is enough to hold one of shift/Esc/F8/F12/Space. Thanks!

I've also updated the boot loader documentation to reflect the change, but I only mentioned holding shift.
I know that changing the documention directly is not preferred anymore, but I wanted to make sure this
patch is complete.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@35050 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-01-13 15:02:55 +00:00
Joachim Seemer
9abc1e0049 deskbar.html was missing in the preference section.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@34561 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-12-08 17:06:54 +00:00
Axel Dörfler
916b34101c * Corrected Alt-` workspace switch description.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@34113 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-11-18 13:49:19 +00:00
Axel Dörfler
289d85d2ac * BWindow::SendBehind(NULL) will now send the window to back.
* Added shortcuts ctrl-alt-F to get a window to front, and ctrl-alt-b to move it
  to the back.
* Updated the user guide with these shortcuts, and also explained the missing
  "single click to bring window to front" behaviour.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@34108 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-11-18 10:33:32 +00:00
Joachim Seemer
8286bcb32e Correcting small typo found by Starseed. Thanks. Though, the userguide is now maintained at http://userguide.haikuzone.net and everything under installation/ isn't currently part of that.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33873 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-11-04 10:56:40 +00:00
Oliver Tappe
571d840abf * dropped svn:keywords property from all files that carried it
to avoid recurring problems during migration of subversion checkouts
  (restored binary files that were garbled by subversions during checkout)
* added appropriate svn:mime-type property for problematic (binary) files
* removed a single (mistyped) svn:mimetype property 
* dropped svn:eol-style property for cleanup (they all contained 'native')



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33670 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-10-19 22:42:52 +00:00
Joachim Seemer
087b6f8e62 Mail isn't ready yet. Revert. Sorry.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33574 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-10-13 15:23:36 +00:00
Joachim Seemer
b717803733 The screenshot shows in fact a PNG, not a JPEG. Thanks HaikuBot for noticing.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33573 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-10-13 15:21:22 +00:00
Niels Sascha Reedijk
49aa230740 Style, spelling and grammar changes. Courtesy of Tim Howe
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33562 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-10-12 21:09:12 +00:00
Joachim Seemer
e0fab22f7d Separating topics with a horizontal line on the contents page. Mentioning translations.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33519 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-10-11 16:19:28 +00:00
Joachim Seemer
13cab1cb73 Worked in Jonas' new Deskbar Preference panel. Thanks HaikuBot for the reminder.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33498 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-10-10 13:17:44 +00:00
Joachim Seemer
958c547554 Some additions and fixes by Idefix. Thanks! Fixes #4748.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33494 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-10-09 15:56:38 +00:00
Joachim Seemer
fa1e6cf851 Changed bullet list to headings. Thanks Oscar Prego for noticing.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33253 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-23 18:17:38 +00:00
Joachim Seemer
e75600d1af UpdatedDiskUsage icon. Nice work, BTW, ZuMi.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33228 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-21 18:54:39 +00:00
Joachim Seemer
87874f4880 More clarifications, pointed out by Alexandre. Thanks.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33171 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-18 16:31:37 +00:00
Joachim Seemer
309cebec10 * Clarified that use of the "Write Boot Sector" button of Installer.
* Clarified the intent of OptionalPackages a bit on the Welcome page. (Unless it
  should be removed completely. This is for an alpha-release, though...)


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33164 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-18 06:25:28 +00:00
Joachim Seemer
5e3ec2fd69 * Clarified that the shortcuts and Favorites menu actually refer to the "Open
and save panels" subchapter in gui.html
* Corrected link to DriveSetup in installer.html


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@33117 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-13 13:31:33 +00:00
Joachim Seemer
3c123ba53f * Added a small section about Replicants to gui.html. If there's more
(for the enduser) interesting info, please add to it.
 * Linked to the Replicant section where appropriate.
 * Added gui-images folder for language-independent images.
 
 +alphabranch


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32968 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-06 17:30:37 +00:00
Joachim Seemer
ddecee790e * Updated poorman screenshot with un-trunkated button.
* Small addition to DriveSetup.
 
 +alphabranch


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32950 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-05 18:31:31 +00:00
Joachim Seemer
12d97bd372 * Added DriveSetup documentation. What came with my last commit wasn't actually
intended to be committed... :)

+alphabranch


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32941 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-05 12:40:08 +00:00
Joachim Seemer
b8d47f16c9 * Removed accidentally added Installation page from bootloader.html nav-bars.
* Updated safe mode options in bootloader.html.
* Renamed menu in Tracker windows "Attributes|Copy/Paste Attributes" to
  "Attributes|Copy/Paste Layout".

+alphabranch


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32909 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-09-02 16:12:39 +00:00
Joachim Seemer
ca8b8ff27b * Applied patch by Vincent Duvent that cures some XML errors. Thanks!
* Vincent also saw that the logo bg-color is #eeeeee instead of #efefef.
  ->Corrected CSS.
  Also, there can be issues with PNG inside div-blocks setting a bg-color. PNGs
  include a color profile that can screw browser rendering to display different
  colors though using the same RGB values. Interesting. See
  http://www.kaktus.cc/weblog/png_and_color_profiles/
  I stripped the color profile info from the logo.png as suggested at that URL.
  Thanks Vincent!

+alphabranch


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32804 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-29 09:39:28 +00:00
Joachim Seemer
2bb19e8b08 * Added more "up-to-top-of-page" symbol/links to h1/h2 headings where appropriate
* Changed "up-to-top-of-page" symbol to a 90° rotated bullet graphic of the new
  website (Good idea, Jorge.). Increased its size to 32x32 so it's easier to
  aim for.
* Mentioned new ~/config/boot/launch/ folder in filesystem-layout.html.
* Updated Workspaces screenshot due to renamed options (Thanks Ryan.)
* Moved magnify.png to the /en/images/apps-images/ subfolder as it's not totally
  language neutral.

+alphabranch


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32759 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-27 15:11:59 +00:00
Joachim Seemer
5a73760650 * Added more "up-to-top-of-page" symbol/links to h1/h2 headings where appropriate
* Changed "up-to-top-of-page" symbol to a 90° rotated bullet graphic of the new
  website (Good idea, Jorge.). Increased its size to 32x32 so it's easier to
  aim for.
* Mentioned new ~/config/boot/launch/ folder in filesystem-layout.html.
* Updated Workspaces screenshot due to renamed options (Thanks Ryan.)
* Moved magnify.png to the /en/images/apps-images/ subfolder as it's not totally
  language neutral.



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32754 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-27 14:17:18 +00:00
Joachim Seemer
99daadc1c2 CSS issue was resolved by Simon Kennedy. Thanks! +alphabranch (is the user guide exempt from this branching business? I swaer, I won't break anything... :)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32654 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-24 15:42:05 +00:00
Joachim Seemer
d616e43574 * Typo in keyboard-shortcuts.html
* Changes on all pages and CSS for
  - min/max width
  - topic title to the left under the logo
  - a new logo (thanks Jorge)
  - refurbished navi bar
  - some more printing tweaks

There are a few CSS issues where I can use some help. I'll post about it on the
documentation mailing list.

+alphabranch


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32651 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-24 12:41:43 +00:00
Axel Dörfler
711af2ac88 * My text wasn't correct 100% either (as #4320 shows).
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32647 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-24 07:31:49 +00:00
Axel Dörfler
8bfaf37fdb * Fixed the wrong translation of the prose to a table.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32646 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-24 07:29:53 +00:00
Joachim Seemer
c6df4ad478 * Once again New e-mail-mailbox.png with vector icon in Deskbar.
* Switching Terminal tabs is done simply by SHIFT+CursorLeft/Right. Fixes #4319.
  Thanks for noticing, diver.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32630 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-23 12:26:23 +00:00
Joachim Seemer
bb8e5b48f9 * Added a link to IRC channels to "Get in contact" and to haiku-3rdparty-dev
mailing list to welcome.hmtl
* Linked to HaikuPorts for BeZilla bug reports.
* Put Axel's tip how to move/send to back (didn't know that!) into a box-info.
  Minor changes to the text.
* Put Axel's "special functionality" of Workspaces into a nice table.
* Added new function to cycle thru windows with CTRL ~ to Twitcher.
* Added CTRL+SHIFT+CursorLeft/CursorRight to switch tabs to Terminals keyboard-
  shortcuts
* New e-mail-mailbox.png with vector icon in Deskbar.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32628 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-23 09:07:38 +00:00
Joachim Seemer
5b9093e57c Forgot 'Nr. 5'. Thanks for noticing, Axel.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32626 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-23 07:25:26 +00:00
Axel Dörfler
feff9eba4a * Added minor missing pieces to the user guide that might otherwise not get
noticed.
* Humdinger, the GUI image does not have item 5) for the resize knob!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32579 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-21 18:44:04 +00:00
Ryan Leavengood
b6b0567fbd - Change Autostart directory name to launch.
- Move the launching of files in this directory from the Bootscript to the
UserBootscript.
- This means we now ship a working UserBootscript instead of just a sample.
- Updated documentation based on this change and Humdinger's suggestions.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32544 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-20 19:21:18 +00:00
Ryan Leavengood
f67cd235ef Add a blurb about the Autostart directory in the bash scripting section. If
there is a better place please move it there. Also fixed a bad link in the
Tracker section.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32528 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-19 21:44:03 +00:00
Joachim Seemer
ade571c524 Changed to the official name 'VLC media player'. Thanks for pointing that out, Urias.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32511 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-19 06:49:17 +00:00
Joachim Seemer
abc73d0a65 * Added a hint on using 3-letter file extensions to filetypes.html.
* Added links to maintaining website of bundled apps.
* Bigger space between heading and contents of apps pages.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32453 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-17 09:22:12 +00:00
Joachim Seemer
7c7436b679 * Replaced "AltGr" and "WIN" keys with "OPT" and removed other hints to a
specific keyboard layout.
* Added a note and link for OptionalPackages to welcome.html
* "Activated" Installer page in contents of applications.html
* Moved BePDF, BeZilla, Pe, Vision, VLC, Wonderbrush to own section "Bundled
  applications". The apps not included in an official image will be removed
  when we what's got to go.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32436 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-16 11:29:49 +00:00
Joachim Seemer
5af0dbf3ca * A few more changes, partly inspired by Philippe Houdoin. Thanks!
If there are more corrections, let me know. I have close to no experience
  installing Haiku...


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32411 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-15 06:40:47 +00:00
Joachim Seemer
09a1793e4f * Corrected link to Welcome page on applications.html.
* Added hint of right-click navigating saved queries.
* Mentioning queries besides files/folders for configuring the Deskbar Menu.
* A few cosmetic changes here and there.
* Added Installer documentation. Corrections welcome, esp. concerning the
 "Write Boot Sector" button.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32346 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-14 08:46:58 +00:00
Joachim Seemer
682d778105 Forgot an updated Configure Deskbar Menu panel screenshot.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32222 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-10 08:39:35 +00:00
Joachim Seemer
16d0e0ce54 * Added workspace navigation with CTRL+ALT+Cursor in workspaces.html and
keyboard-shortcuts.html.
* Added workspace arrangement in Screen preferences.
  Updated screenshot.
* Added newly learned shortcuts: CTRL+ALT+Z to maximize a window and CTRL+ALT+M
  for minimizing and CTRL+ALT+H to hide all windows of an app.
* I-O-M: Removed "Transformation" and "Perspective" from the available
  transformers until those are implemented.
  Same for the Shape property "Rounding".
  Added description of Path|Rotate Vertices Right/Left.
  Thanks Stippi for working on these I-O-M tickets!
* Corrected bottom nav-bar of apps-terminal.html.
* Added black-on-white output for pre.terminal when printing to Haiku-docs.css.
  (Thought I did that already, but apparently not...)
* Added "Ignore Double-click" to launchbox.html.
* Updated all screenshots to show the new decorator design.
* Ran all images thru OptiPNG which losslessly made them on avg. 11% smaller.
* Updated sort order indicator in attributes.html
* Added how to use pop-up navigating for moving files in tracker.html


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@32221 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-08-10 08:18:39 +00:00
François Revol
bb18a8faa7 Add links to packages for Puppy Linux, as listed by Scott Kemp.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31967 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-30 13:01:57 +00:00
François Revol
f4c56abadc Patch by Pieter Panman: add wget to the documented dependencies on Linux.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31851 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-28 16:07:34 +00:00
Joachim Seemer
714d0c0567 * Fixed link in applications.html
* Added "setup wizard" and some info on IMAP to prefs-e-mail.html. IMAP is a bit
  broken, as was recently found out, so I'll leave it all at that for now.
* Moved every localization-dependent image into a mirror image folder under its
  language (ATM there's only "en"). Only neutral images like icons remain
  directly under /docs/userguide/images.
* Changed all image links accordingly.
* Removed all height and width attributes to ease exchanging images. Only fixed
  size images (icons) will retain them for faster loading.
* Added a special pre.terminal for printouts to save ink. Thanks Rob Tijssen for
  that suggestion.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31622 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-17 17:14:31 +00:00
Joachim Seemer
3dcda2693e * Fixed typos.
* Added links to bug tracker and mailing list etiquettes. I don't think those
  have to be available offline. Other opinions?
* Moved warning about the alpha status in welcome.html into a warning box.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31461 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-08 16:26:00 +00:00
Ryan Leavengood
675c4cfb4e Tiny typo: 0,25 becomes 0.25. BTW, great document (I learned some good stuff!)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31438 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-07 02:35:48 +00:00
Ryan Leavengood
16a6c66131 I like your changes Humdinger (much more readable) but there were a few typos.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31437 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-07 01:57:45 +00:00
Joachim Seemer
a4a0a6665e * Applied Adek336's small patches to install-source-linux.html. Thanks!
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31428 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-06 17:32:26 +00:00
Joachim Seemer
25ab629645 * Renamed the "Contents" box to "Index" because we already link to the "global"
contents.html on every page.
* Added an index box to Queries, Tracker, Email prefs, workshop and Deskbar. If
  anybody find another topic should get an index box, I'll add it.
* Little css tweak for the contents/index box.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31426 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-06 16:53:55 +00:00
Joachim Seemer
312796d730 * Remodeled Ryan's addition to Twitcher into a layout widely used in our guide.
Hope you don't mind, Ryan.
* Moved Stippi's tip about the context menu in I-O-M into the path section.
  Hope you don't mind, Stephan.
* Linked to the Icon-O-Matic page where icons are discussed.
* Changed the index box at the top of I-O-M to use css and added the entries
  into Haiku-doc.css.
  I really don't know what I'm doing exactly here. Can someone have a look and
  improve things? I'd soon like to add such an index box to other long topics.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31414 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-05 18:23:20 +00:00
Ryan Leavengood
81e8a97450 Some userguide tweaks for the Twitcher which I have learned more about
recently. It is more advanced than I thought.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31408 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-05 05:03:23 +00:00
Stephan Aßmus
1c55ed0826 A small correction and one additional tip.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31406 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-04 12:31:55 +00:00
François Revol
73391e5db7 Since we do have the Icon-O-Matic doc, don't say it's missing anymore.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31405 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-04 08:48:37 +00:00
Joachim Seemer
35c255e59d * Thanks to axel, "keymap" can now dump a text file directly.
* New screenshot of Find window with improved(?) numbers style.
* Haiku-doc.css: content font-size is now 0.9em
* Added documentation for Icon-O-Matic. Comments/Corrections very welcome.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31403 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-07-04 04:27:42 +00:00
Joachim Seemer
f6fcf9b832 * Set html MIME type for apps-charactermap.hmtl.
* Added CharacterMap to applications.html contents.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31148 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-06-21 07:11:22 +00:00
Joachim Seemer
d27c52da2b * The topnav bar wasn't high enough. Small change in Haiku-doc.css solved that.
* Corrected link in Fonts preferences.
* Added Mount menu item and changed Shutdown menu item in Deskbar.
  Updated screenshot.
* Updated Keymap documentation and screenshot (comments welcome, esp. for the
  keyboard commandline part at the end).


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31144 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-06-20 18:30:05 +00:00
Joachim Seemer
7d62dd099d Forgot to mention the super-special-extra setting for the menu font...
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31034 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-06-13 16:48:12 +00:00
Joachim Seemer
a7875ee825 * Added the drag&drop of images in Backgrounds preferences.
* Updated ActivityMonitor with the interval setting panel and took a new
  screenshot.
* Added documentation, icons, screenshot for CharacterMap (comments welcome, as
  I'm not excatly the target for this app, I guess).
  Added entry in Applications contents and adjusted links accordingly.
* Removed Menu preferences as it's settings have been moved to other panels.
  Adjusted links to it accordingly.
* Added zuMi's fine Poorman icon (Poor man, carries the weight of the planet.)


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@31033 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-06-13 16:43:13 +00:00
Joachim Seemer
999f69ee3a * Included lelldorin's tip on using the html2pdf add-on to overcome BeZilla's
aversion to printing.
* Fixed typo in apps-bepdf.html.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30789 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-18 15:03:44 +00:00
François Revol
eacc46fabe You also need gcc-multilib and g++-multilib on 64bit...
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30778 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-17 02:31:25 +00:00
François Revol
b83e8d5fcb - add links to apt: url to install packages for Ubuntu,
- add mention of libc6-dev-i386 which I had to install on a 64bit server,
- fix a typo.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30777 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-17 00:40:43 +00:00
Joachim Seemer
2f535f20c0 Added a line for adding the Development optional package, so the @ disk case wouldn't be empty.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30760 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-14 15:58:15 +00:00
Joachim Seemer
d68ad369c3 Added installation.html once more. Sorry for all the mess...
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30753 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-13 18:15:30 +00:00
Joachim Seemer
8613c15d30 Once more removed installation.html just
to re-add it afterwards...

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30752 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-13 18:14:44 +00:00
Joachim Seemer
f45c0ffde7 The apps-people.html wasn't supposed to be commited yet, but what done is done, so here's the rest... :)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30707 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-11 16:12:53 +00:00
Joachim Seemer
8e125d19c2 Removed out of date installation.html which was moved to /installation/install-source-linux.html a while back. Thanks for noticing, Matt.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30706 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-11 16:08:21 +00:00
Joachim Seemer
cac3cbcda8 It was brought to my attention that 'HAIKU_DONT_CLEAR_IMAGE = 1' is supposed to be redundant in case of a @disk build. I'm woefully ignorant of the intricacies of our buildsystem, so I just accepted that and ran with it. :) Thanks Matt (and Urias by proxy).
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30705 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-05-11 15:36:40 +00:00
Joachim Seemer
077496d6d5 Purged the last reference of /boot/beos/. Thanks bbjimmy.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30462 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-04-27 15:20:52 +00:00
Joachim Seemer
358e9381ea * Added Michael's suggested developer checkout for the build tools.
* Small corrections to Magnify.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30434 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-04-26 16:54:32 +00:00
Joachim Seemer
705a97b615 * Added documentation for the app Screenshot.
* Adjusted links in the nav-bar of all the apps' docs to jump to the
  #list-of-apps instead of to the top of applications.html


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30397 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-04-25 16:45:26 +00:00
Stephan Aßmus
2468b98190 Fixed links to BePDF's own docs.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30365 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-04-24 10:47:27 +00:00
François Revol
dd2625bfb0 Some print-specific CSS rules, after those I did on my resume:
- inline acronym definitions and remove the dotted underline
- inline urls for a tags with printurl class (we don't want all of them printed)
- noprint class for things we might not want to print at all


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30347 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-04-23 15:38:16 +00:00
Joachim Seemer
b43891053d * Documented "type ahead" and the new function to Close All in Workspace (ALT+Q)
in tracker.html
* Documented PoorMan.
* Added yasm to the required packages when building Haiku under Linux
* changed every /boot/beos/ to /boot/system/


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@30247 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-04-18 19:05:57 +00:00
Michael Lotz
674996257b Update the cross-compiler link to the current version.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29873 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-04-03 01:31:15 +00:00
Ingo Weinhold
9ab8968af3 Added sections on checking access permissions, node monitoring, and caches.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29797 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-30 02:22:27 +00:00
Ingo Weinhold
0551e706bf * Updated to current FS interface.
* Fixed and completed several function documentations. There's still quite
  a bit missing.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29787 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-29 17:17:55 +00:00
Ingo Weinhold
d117d093a2 Updated the FS introduction. It's in sync with the current API again, but some
new sections for caches and FS layers should be added.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29768 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-28 21:50:19 +00:00
Ingo Weinhold
50c9917f8f Resurrected the FS interface documentation and introduction. It's not in sync
with the current API, but it just needs to be updated rather than rewritten
from the scratch.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29766 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-28 21:00:53 +00:00
Stephan Aßmus
3d7e16f849 Updated Copyright.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29676 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-24 12:40:43 +00:00
Stephan Aßmus
8395cc347e Removed Windows line breaks.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29675 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-24 12:40:24 +00:00
Stephan Aßmus
87854b4cfc * Fixed the space below the logo.
* Align the title with the logo base line.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29674 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-24 12:39:51 +00:00
Joachim Seemer
b3abe8046a * Small improvements here and there, esp. heading hierarchy.
* Renamed "Showimage" to "ShowImage". Thanks mmadia.
* Some more tweaking of box padding in the CSS.
* Added "Expander", adjusted contents of applications.html


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29648 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-22 08:45:56 +00:00
Stephan Aßmus
c61af1596f Proof-read the installation guide (very cool work!), some small fixes and
improvements. I added mentioning the UserBuildConfig a couple more times
further down, just in case someone skipped these parts. Then the mentioned
commands won't work.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29606 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-19 09:04:21 +00:00
Joachim Seemer
8e7383619d * Added DiskUsage
* Tweaking box padding in the CSS


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29465 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-10 18:26:29 +00:00
Joachim Seemer
b8dbc0a275 Forgot one instance of 'Firefox'. Also, being Mozilla, I guess we can dispense with our own documentation for it. Unless there are interesting Haiku-only features. We'll see.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29400 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-04 21:01:52 +00:00
Joachim Seemer
bff14db1e8 * Added DiskProbe
* Changed cursor keys to their respective arrow symbol
* As mmadia reminded me: since we cannot use Mozilla's Trademarks I renamed
  everythig firefoxy to BeZillaBrowser.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29398 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-03-04 17:29:50 +00:00
Joachim Seemer
e564a3c1f7 * Added more CSS control for menus, buttons, app names, shell commands, paths.
* Always wanting keyboard graphics for shortcuts, Jorge suggested simple borders
  for simplicity. Great idea! Added.
* Added Jorge's rounded boxes for note/warning/stop plus symbols.
* If anyone wants to fine tune esp. colours, go ahead. Jorge and I are both
  challenged in that department. :)
* A few small corrections and reformatting here and there.
* Excluded the topic "Installation" from the contents until it's further along.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29269 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-21 11:40:17 +00:00
Niels Sascha Reedijk
dae3adab03 Rewording by Tim Howe with some suggestions by Bob Colwell. Thanks guys.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29262 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-20 10:20:54 +00:00
Niels Sascha Reedijk
25630ec983 Removing the file system interface documentation for now. This needs to be replaced with a completely new version that accounts for all the new features (including the overlay modules)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29243 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-18 11:04:27 +00:00
Joachim Seemer
e7d577748b * Added the Tracker preference panel which points to the Tracker chapter,
which in turn mentions the new Tracker preferences. Thanks aldeck for
  reminding me.
* Added Tracker icons.
* Added Tracker on the Preferences contents page.
* Small tweaks and corrections here and there.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29183 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-11 16:29:31 +00:00
Joachim Seemer
ad7fb638cb Hopefully now correct procedure without use of sudo. Also added OptionalPackages to the mix. Some formatting stuff.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29157 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-08 08:12:26 +00:00
Joachim Seemer
59ee5c81c0 Corrected jamming of images, not unnecessarily create root files by first doing a {jam -q} and then {sudo jam -q}.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29147 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-07 14:02:16 +00:00
Niels Sascha Reedijk
702a1e7241 Tweak looks of API documentation.
WIP:
 * Only a first subset of CSS has been applied
 * Look based on Humdinger's and other's work on user guide
 * Navigation is still ugly. I need to work around the limitations of Doxygen. Maybe by a patch though.
 * Needs a manual extra step: you need to copy the /trunk/docs/userguide/images/logo.png to the /trunk/generated/doxygen/html directory

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29117 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-02-01 21:44:07 +00:00
Joachim Seemer
7c2cc28dc9 * Added input tolerance of DeskCalc, moved Terminal function to end of list
* Added CodyCam to list of apps in applications.html
* Added aligning tip for icons to tracker.html
* Added a few tips for working in Terminal
* Added a topic on scripting, linking to online resources
* Described function of UserBootscript an shutdown scripts


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@29105 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-01-31 22:55:49 +00:00
Joachim Seemer
9384249452 * Added Philippe ("Socapex_2K") Groarke's work on an installation topic.
It's based on the blog articles of several people that will be credited in each
  page's header comment soon.
* Did a little additional formatting and restructuring.
* This is still a work in progress as we continue to restructure and remove redundancies.



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28925 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-01-17 18:05:49 +00:00
Philippe Houdoin
58a9f0902b Ooops, it was not Capitalized.
BTW, sometimes it is (undocumented application pages), sometimes it's not.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28895 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-01-14 00:30:33 +00:00
Philippe Houdoin
e812decffc Fixed Documentation Mailing list broken HTML tag.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28894 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-01-14 00:25:02 +00:00
Joachim Seemer
17c89cf196 This file apparently didn't make it with my last commit.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28893 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-01-13 14:44:55 +00:00
Joachim Seemer
077a475a14 * Added docs of applications:
CDPlayer and CodyCam (both work in progress), DeskCalc
* Started installing.html.
* Added a screenshot of Glyph+Subpixel rendering to Appearance prefs.
* Mentioned new setting "Monospaced Fonts Only" glyph hinting in Apperance prefs
* Mentioned sysinfo and listdev in bugreports.html as pointed out by scottmc.
* Some tweaks to the Haiku-doc.css.
* Put a link to http://www.haiku-os.org/community into welcome.html,
  removed the "(online)".
* Reorganized the file hierarchy to accommodate future translations. See thread:
  http://www.freelists.org/post/haiku-doc/Organizing-translations-of-User-GuideWelcome-Package.
* Added a userguide/languages.html that will serve as entry for the different
  translations.
  Since the welcome page is more or less only one page, we'll find another
  solution for that when the first translations are available. 


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28890 a95241bf-73f2-0310-859d-f6bbb57e9c96
2009-01-12 15:58:51 +00:00
Stephan Aßmus
1f92a41ace Patch by Humdinger with the following commit message:
* Added explanation of icons to Bootloader.
* Applied css-fix by Braden Ewing to fix rendering under MS Internet Explorer.
  Added Braden to welcome.css authors.
* Added a css class pre.terminal to make Terminal output more visible plus a few more
  things. Added myself to welcome.css authors. :)
* Updated all Terminal output with the new pre-class tag.
* Flaunted our beautiful icons at the top of every preference/application/applet plus
  their contents page.
* Added icon PNGs in 16x16 32x32 and 64x64.
* Added quick info where to find a preference/application/applet and its settings at the
  top of every page.
* Added apps: ActivityMonitor, Magnify, StyledEdit, Terminal
* Added applet: Launchbox
* Added stubs to all missing prefs/apps/applets. Everyone's welcome to work on the
  contents (announce it on the mailing list, though!).
* Moved preference/application/applet into own folders.
* Updated contents page.
* Reformatted everything to be XHTML1.0-Strict conforming. Added XHTML DTDs to
  welcome/html-dtd/.
* Added copyright and author as comment to the header of every page. If someone else
  should be mentioned there, speak up.

---
Whoot! What a titanian piece of work, Humdinger!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28791 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-12-09 23:31:04 +00:00
Stephan Aßmus
e0540f7ee3 Patch by Humdinger:
* Added docs and screenshots for preference panels:
     Appearance, Backgrounds, DataTranslations, E-mail,
     Filetypes, Fonts, Keyboard, Keymap, Menu, Mouse,
     Network, Screen, Screensaver, Sounds, Time, VirtualMemory
    Adapted some contents for E-mail preferences from
    src/documentation/haiku_user_guide/HaikuUserGuide.txt
    As I haven't succeeded to get email running in vmware, I'd appreciate if someone
    can proof read what's written in E-mail preferences.
* Added preferences to the user guide contents.
* Various formatting details and inter-documents-links

Wow! Thanks a lot!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28555 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-11-07 21:16:24 +00:00
Stephan Aßmus
d9e3b747bf * Mention Alt+N and Alt+E as the most useful shortcuts in a Filepanel
* Unify description style


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28410 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-31 19:04:49 +00:00
Stephan Aßmus
1e2b06a58b Patch by Humdinger:
* Slightly improved the wording on the Welcome page
* Corrected some wrong HTML tags here and there
* Improvements on the Bug Reports page
* Added paragraph on file panels on the general GUI page
* Added Filesytem Layout page
* Added Boot Loader page (kernel boot options)
* Added Keyboard Shortcuts page (also moved the paragraph about default command
  key there)
* Prepared index pages for Applications, Preferences, Demos and Desktop Applets


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28389 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-31 09:08:15 +00:00
Stephan Aßmus
7e47a4ee00 patch by Humdinger:
* Various fixes and corrections
* Preparation for new sections


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28332 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-26 11:23:20 +00:00
Stephan Aßmus
c4b429ca1c Patch by Humdinger:
* Refactored a User Guide style documentation from the previous Welcome
  documentation. The Welcome documentation links to the User Guide, the
  biggest difference is that there is now a separate contents page.
* Improvements to the text.
* Added Tracker-Add-ons page.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28211 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-17 09:53:43 +00:00
Stephan Aßmus
cd88f4c042 Patch by Humdinger:
* Added the missing Team Monitor intro.
* Fixed navigation in the preceeding and following files.

Changes by myself:
* Removed the bottom navigation in the Twitcher intro, since the file is so
  short anyways.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@28027 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-13 11:53:22 +00:00
Stephan Aßmus
e6660ca0ae Patch by Humdinger:
* Improved Tracker and Deskbar introductions.
* Updated and improved a few graphics and added some more.
(Humdinger: The Teammonitor intro was missing from your patch.)


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27995 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-12 14:10:56 +00:00
Stephan Aßmus
64546f13ae Removed wrong additional line breaks for spacing.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27941 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-09 12:05:08 +00:00
François Revol
2bd9dd82a6 Unix is a name, should be capitalized. (it's actually a trademark too)
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27933 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-08 23:30:53 +00:00
Stephan Aßmus
9000a4b179 * Fixed some layout issues here and there.
* Fixed wrong link to filetypes workshop.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27932 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-08 23:25:32 +00:00
François Revol
afa07bfacd Some acronyms.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27931 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-08 22:59:59 +00:00
François Revol
7a9f779fb7 Better definition for OsDrawer
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27930 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-08 22:04:01 +00:00
Stephan Aßmus
20bf7d63a4 * More conversion to using CSS. The complicated table for layouting is gone,
the logo area is very simple now, as well as the navigation area. Tweaked
  the looks to remind a little of the Haiku website look.
* Incorporated patch by Humdinger (better "Open With..." menu screen shot,
  added "Open With Preferred" screen shot and text.)
* Some minor fixes here and there.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27929 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-08 20:51:49 +00:00
François Revol
79097ca072 Add comment on haikuports and osdrawer
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27924 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-08 13:49:52 +00:00
François Revol
ff00865639 Add a CSS and use it from the first page.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27923 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-08 13:39:23 +00:00
François Revol
15202c31b1 Add OsDrawer to the list of 3rd party sites.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27922 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-08 13:05:00 +00:00
François Revol
6f79e8aa0a Make bugreport page look like others.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27919 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-07 22:41:25 +00:00
François Revol
5147e003da Make the workshop page look the same as others.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27918 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-07 22:33:12 +00:00
François Revol
e441386a78 Fix display in NetSurf which doesn't notice the <body> parameters. visited link color isn't handled yet though.
Fixed a typo.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27917 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-07 22:22:19 +00:00
Stephan Aßmus
586376a3fc Worked over the design and some of the text of the "Welcome" documentation.
* Changed the design of the logo area and worked on the document margins
  and overall layout.
* Added a navigation infrastructure.
* Worked on the text on the Welcome page - Added an actual welcome paragraph
  and unified the bug sections. Slightly changed the paragraph ordering.
* Fixed some typos, added small bits of text to the Tracker topic.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27907 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-07 21:04:11 +00:00
Stephan Aßmus
bf8eb495e2 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
2008-10-03 08:03:14 +00:00
Stephan Aßmus
f75a7bf508 Imported the nice disk usage tool "Guido" into the repo as "DiskUsage". Guido
was originally written by Mike Steed. The code was freely available from his
website at one point, which I am no longer able to find. I believe the license
was a kind of public domain, at least compatible with our MIT/X11 license.

The original code was well written with it's own coding style which was not
very far from the Haiku coding style. I have hopefully adopted it completely
to our coding style. While I did this, I came across several places with
comments for a minor bug which I was able to resolve all. I also found ways
to simplify certain places and I elliminated all non-necessary "inter-class
knowledge" which was used to directly access members of other classes which
should have been private.

All in all, this should be a nice little addition, a useful tool which I found
handy a lot of times. If I should not have added this without first consulting
everyone, please voice your disagreement, and it can be removed it again. It
is not part of the image yet.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27357 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-09-07 14:18:01 +00:00
Ingo Weinhold
c909ca65bf Patch by Zhao Shuai: Updated documentation regarding the use of the
radix tree.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27356 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-09-07 13:58:49 +00:00
Stephan Aßmus
fc75bbd740 * The analysis for how DriveSetup works on BeOS is no longer relevant and
Haiku's own DriveSetup works differently.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27354 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-09-07 13:38:12 +00:00
Ingo Weinhold
9837b719af Some documentation on swap file support by Zhao Shuai.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27203 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-08-25 22:09:45 +00:00
Axel Dörfler
d11a6916ee More or less completed the introduction. I would just want to add the image,
and publish it on the website - comments are still welcome, though.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25802 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-06-04 11:40:00 +00:00
Axel Dörfler
30f7fc408b An early version of an introduction to the new device manager. Will be expanded
more over the following days, and published on the website.
Comments welcome!


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25760 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-06-02 15:45:22 +00:00
Ingo Weinhold
67e2e88213 Added a section to the select() hook documentation discussing the FSs
responsibility never to call notify_select_event() after deselect().


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25262 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-04-29 21:52:30 +00:00
Niels Sascha Reedijk
ce9ba9b376 First version of the BMessageQueue documentation.
Note: I have cleared the original MessageQueue.cpp file from the inline documentation. When the storage kit comes up, we need to rediscuss the documentation policy.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24522 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-03-22 14:36:20 +00:00
Ingo Weinhold
1b32947d3f * Aligned the semantics of the read_symlink() FS module hook with the
readlink() function. It is no longer required to null-terminate the
  string, shall not fail, if the buffer is too small, and shall return
  the length of the string actually written into the buffer.
* Adjusted rootfs, devfs, and bfs accordingly. Also adjusted their
  read_stat() hooks to return the correct symlink length in st_size.
* Our readlink() does now comply to the standard (and BeOS).
  Additionally if the buffer is big enough it is nice to non-conforming
  apps and null-terminates it.
* BSymLink::ReadLink() explicitly null-terminates the string now.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24425 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-03-17 21:37:40 +00:00
Niels Sascha Reedijk
0f3d1b86b0 Correct some mistakes pointed out by Stephan
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24338 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-03-09 20:39:57 +00:00
Niels Sascha Reedijk
da3abc7c16 Handler.dox:
- Small link fix
- Clean up the titles of the subsections a bit: these are reused in the looper documentation and they sort of clashed before.

Also, new documentation for Looper.dox!

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@24304 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-03-08 15:11:39 +00:00
Niels Sascha Reedijk
a7f59ef8eb Fix the description for StartWatching() after a hint from Axel. There are two different behaviours for both overloaded variants. (which is bad, IMO)
*waves at Axel*

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23443 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-01-12 16:57:50 +00:00
Niels Sascha Reedijk
6fd8b07afc Add a note about using messages for data storage. Thanks to mlotz for telling me this functionality was underexposed in the current docs.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23170 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-12-27 13:30:30 +00:00
Niels Sascha Reedijk
3f56983aa8 Small typo
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23169 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-12-27 13:19:45 +00:00
Niels Sascha Reedijk
301744b8ac Phase I of the BHandler documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23168 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-12-27 13:17:20 +00:00
Axel Dörfler
3721f6df39 Minor update; even though the TODO file isn't that long anymore, it doesn't
hurt to have it in the repository.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22990 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-11-24 15:43:46 +00:00
Niels Sascha Reedijk
4f6e481644 Some improvements suggested by Axel. Thanks.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22576 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-10-15 19:56:05 +00:00
Niels Sascha Reedijk
dcdb996481 Phase I of the Message.dox file
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22564 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-10-15 11:49:54 +00:00
Niels Sascha Reedijk
445e975fda Correct typo. Fix bug #1548
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22543 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-10-13 22:13:42 +00:00
Niels Sascha Reedijk
51e5c73eca Phase I of MessageFilter.dox
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22350 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-09-28 21:14:39 +00:00
Niels Sascha Reedijk
b15c8e82c2 Minor fixes. Finishes the first version.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22264 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-09-19 22:22:41 +00:00
Niels Sascha Reedijk
575d819a54 First part of the messaging overview
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22240 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-09-17 21:33:24 +00:00
Niels Sascha Reedijk
8a44618225 Create framework for Application Kit.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21851 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-08-08 10:29:30 +00:00
Niels Sascha Reedijk
99b3aeed2d git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21837 a95241bf-73f2-0310-859d-f6bbb57e9c96 2007-08-06 14:28:40 +00:00
Niels Sascha Reedijk
55f7db1bd9 Update according to the latest guideline changes. These files already
passed phase 3, so they wouldn't be updated during the regular process. 
I guess the other files will get that update.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21833 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-08-06 09:32:27 +00:00
Niels Sascha Reedijk
ff3d9bfa2a Update the API guidelines to make them more consistent with the coding
guidelines. Three new guidelines:
- Commas between names and email adresses in header blocks.
- Indent with tabs (with lenght 4)
- Two whitelines between blocks


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21832 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-08-06 09:09:29 +00:00
Axel Dörfler
2aacca4469 Brought the document up to date; triggered by an update to this document by
Kamikazow which can be seen as an attachment to bug #1356.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21831 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-08-06 00:03:49 +00:00
Niels Sascha Reedijk
40ba6c7004 Fix a mistake. \code should always be closed by \endcode, else doxygen will stop parsing (even if a documentation block ends).
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21694 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-23 22:41:58 +00:00
Axel Dörfler
ca210f74f1 * Spaces to tabs.
* Carriage returns to simple new lines.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21627 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-16 21:47:13 +00:00
Axel Dörfler
5d92d947c2 * Completed some more missing parts.
* Replaced some more spaces with tabs, though still not complete.
* And I forgot: the last commit also removed some garbage at the beginning of the file.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21617 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-15 18:09:43 +00:00
Axel Dörfler
84f03dd594 * Removed deprecated functions.
* The documented the notify_*() functions - only notify_listener() was deprecated
  among them.
* Replaced spaces with tabs - there is no reason to deviate from the standard we're
  using everywhere else.
* Completed the docs here and there.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21615 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-15 13:31:02 +00:00
Niels Sascha Reedijk
412a49defe Update to the latest prototypes of fs_interface.h
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21584 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-07-07 08:29:52 +00:00
Axel Dörfler
a492532bd9 Get rid of outdated and mostly useless docs, updated some of the comments in the source.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21529 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-30 13:58:41 +00:00
Axel Dörfler
88799a5d97 An almost complete overview over the VM locking/reference count methods and their inherent problems.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21528 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-30 13:49:31 +00:00
Niels Sascha Reedijk
b653632762 Wrote as much documentation as I could understand. There are quite a few gaps left (search for TODO). I hope people (Ingo, Axel?) with more knowledge on this subject can check the written docs, make suggestions for improvement, and fill the gaps. After that, it needs a good revision to make the whole more consistent.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21483 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-21 16:29:43 +00:00
Niels Sascha Reedijk
cb15abc767 Update to Doxygen 1.5.2.
Please update your executable if you are generating the documentation.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21404 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-13 12:53:48 +00:00
Niels Sascha Reedijk
e3c5ca8539 Patch by Thom Holwerda. Proofreading.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21318 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-06-04 06:37:04 +00:00
Niels Sascha Reedijk
37503f54ec Technical proofreading by David Weizades.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21264 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-29 15:24:25 +00:00
Niels Sascha Reedijk
dc84754eef Patch by Thom Holwerda:
"Phase III .diff for BlockCache.dox.

Not much to change here, some really minor things only. The thing
that makes the .diff large is the fact that many lines were more like
70char than 80char."

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21258 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-28 12:18:49 +00:00
Niels Sascha Reedijk
8ace9affed Work in progress. I'm still working on documenting many of the fs hooks, but I just wanted to commit this to quiet down the amount of warnings that are produced.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21257 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-28 08:18:43 +00:00
Niels Sascha Reedijk
c24f6c7e26 Add some more credits. I hope I got everyone now.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21256 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-28 08:11:24 +00:00
Niels Sascha Reedijk
5dee3b1245 Initial version of the TLS documentation.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21226 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-24 11:13:20 +00:00
Niels Sascha Reedijk
8b44d0db76 Patch by Thom Holwerda.
Proofreading.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21219 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-23 13:25:33 +00:00
Niels Sascha Reedijk
1e36cfc272 Move the 'mail' documentation out of the Haiku Book.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21218 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-23 10:03:30 +00:00
Niels Sascha Reedijk
bef614ef09 Add Credits to the Haiku Book.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21217 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-23 09:25:00 +00:00
Niels Sascha Reedijk
bdad0425c4 Patch by David Weizades
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21208 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-22 16:50:08 +00:00
Niels Sascha Reedijk
02d0a2eab1 Patch by David Weizades (thanks!):
"Fixed the indentation and went over the cross references. Everything appears
to be in order and should be ready for committal. It adheres to the coding
guidelines and should be good to go."

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21206 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-22 13:58:43 +00:00
Niels Sascha Reedijk
de41d9ee27 Update the guidelines acording to the decisions during the meeting
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21188 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-21 15:45:39 +00:00
Niels Sascha Reedijk
0d975479fb First iteration of the documentation that describes how to write drivers that use the USB module.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21162 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-17 16:08:33 +00:00
Niels Sascha Reedijk
5625684593 Patch by Alan Smale:
"I have made the doc header consistent with what the document content
specifies it should be.

I've rephrased things and corrected typos and spelling.

Checked through the grammar and amended some gramatical errors."

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@21103 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-05-10 09:02:45 +00:00
Niels Sascha Reedijk
b821eb28c8 git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20838 a95241bf-73f2-0310-859d-f6bbb57e9c96 2007-04-26 11:13:29 +00:00
Niels Sascha Reedijk
81071f5e8a Large documentation update:
- Add the beginnings of the documentation for the USB module
- Fix some mistakes here and there
- Almost finished the support kit. Tried to update everything to the standards

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20724 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-04-16 09:28:29 +00:00
Ingo Weinhold
8338b05a30 More FS interface documentation. All FS hooks required for writing a basic
read-only FS are documented, now. Be encouraged to review and add more. :-)


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20568 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-04-04 23:46:05 +00:00
Ingo Weinhold
3458a335ab Started documenting the FS API a bit.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20544 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-04-04 01:27:50 +00:00
Niels Sascha Reedijk
9889ca4a68 * book.dox Reformat according to the guidelines
* BufferIO.dox Reformat according to the guidelines
* DataIO.dox Reformat according to the guidelines
* Flattenable.dox New documentation.
* Locker.dox Finished documentation.
* SupportDefs.dox Reformat according to the guidelines

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20511 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-04-02 11:39:10 +00:00
Niels Sascha Reedijk
e24e2c66c9 Push some doc changes I have on my harddrive. They don't (all) conform to the guidelines, but I wanted to put these in the repository nonetheless.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20472 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-03-30 13:50:00 +00:00
Niels Sascha Reedijk
a38ee20f99 Initial revision of the API documentation guidelines up for discussion. DataIO.dox and List.dox conform to these guidelines.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20392 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-03-19 09:38:47 +00:00
Niels Sascha Reedijk
89e18a513c * Take a document on compatibility from the Haiku website (experimenting with pages) - Originally written by Ingo and updated by others, I have permission from Ingo.
* book.dox Rework a bit of the structure
* midi2/support Separate the overview (or Introduction) from the list of elements in a module.
* support Wrote initial documentation for Beep/BufferIO/DataIO
* Stub for article on archiving.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20307 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-03-02 13:36:32 +00:00
Niels Sascha Reedijk
9d54b14368 * Add documentation for BAutolock, BBlockCache and BList
* Finish up documentation for BString
* Trying to work a bit more on the structure.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20236 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-02-26 10:34:35 +00:00
Niels Sascha Reedijk
9662cf00d7 Remove useless file.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20208 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-02-23 15:29:33 +00:00
Niels Sascha Reedijk
089b7ad4c6 Some more work on the Doxygen version of the haiku_book.
I will keep working on the Docbook version, but as I'm still not completely comfortable with that as final choice, I'm playing around with this as well.

The String.cpp file contained doxygen documentation for almost all methods, I copied those to a new file (string.dox) and grouped them accordingly. (Done because Axel is absolutely against in-header or in-source docs)

Integrated the BMidiConsumer and BMidiLocalConsumer class into the same file (like I did now to the producers), since I think it's better to keep a 1:1 relation with the headers. 

Removed the mididefs.dox file and replaced it with the midi2/Midi2Defs.dox file which actually documents the Midi2Defs.h file, rather than contain a custom page that was somewhat hard to find.

Please see http://www.myhouserules.nl/haiku_book/index.html for a generated book from the current source. I actually quite like the output so far, though I'm aware of the fact that I needed to perform some tricks to let Doxygen get to this point.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19651 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-12-29 00:26:34 +00:00
Niels Sascha Reedijk
515dc58881 Play around with doxygen a bit more, since I don't want to give up on it just yet.
Started 'copying' some comments from the String.cpp file. 

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19642 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-12-27 17:46:38 +00:00
Stephan Aßmus
d01c27d4f1 * documenting small addition to protocoll when handling flat vector icon data
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19190 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-11-03 09:41:20 +00:00
Niels Sascha Reedijk
d419ca3b7b Update API documentation and Doxyfile to improve the output.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18822 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-09-12 12:13:49 +00:00
Niels Sascha Reedijk
e932ec1af2 Revert earlier removal.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18801 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-09-11 08:50:10 +00:00
Niels Sascha Reedijk
61da80a80a This documentation is converted to docbook.
Check the trunk/src/documentation/haiku_book subdir.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18791 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-09-10 17:18:21 +00:00
Niels Sascha Reedijk
cf6a825f1f Move the UI guidelines to src/documentation location and add a Jamfile for compilation
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18768 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-09-05 21:24:56 +00:00
DarkWyrm
f4458b2588 Removed a few misspellings
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18735 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-09-02 19:54:22 +00:00
DarkWyrm
e23bf5454e Finished the appendix and converted guidelines to DocBook
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18734 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-09-02 13:19:06 +00:00
Ingo Weinhold
6bfd06d1ff BRoster::Launch() eventually launches the application in question
in several steps:
1. early pre-registration with the registrar ("I wanna launch the
   app, make sure noone interferes.")
2. load the app image
3. finish pre-registration with the registrar ("I have launched
   the app, here is its team ID.")
4. start app main thread
5. send "on launch" messages to the app (argv, refs, others)

If the app is already running or being launched, 1. fails with a
conclusive error code and returns the team ID and the pre-registration
token of the app. Steps 2 - 4 are skipped and only the messages are
delivered using the team ID returned by 1.

This change fixes a race condition: The failed early pre-registration
request obviously cannot return the team ID, if the other thread
launching the app has not finished step 3 yet. Thus the argv/refs
message would not get delivered and Launch() would not return the
correct team ID.

Now we wait for the pre-registration to be finished in this case, using
the former _IsAppPreRegistered() mechanism, which already provided
such a waiting feature for one request. It has been extended to
accomodate an arbitrary number of waiting requests and renamed to
_IsAppRegistered().

This fixed bug #763.



git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18728 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-08-31 17:54:16 +00:00
DarkWyrm
f30d1a521a Some initial revisions for the first 11 chapters or so
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18292 a95241bf-73f2-0310-859d-f6bbb57e9c96
2006-07-27 01:30:57 +00:00