Commit Graph

252 Commits

Author SHA1 Message Date
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