gryf/window-maker.github.io
1
0
Fork 0
mirror of https://github.com/gryf/window-maker.github.io.git synced 2025-12-18 20:10:20 +01:00
Code Issues Projects Releases Wiki Activity

Deploy gryf/window-maker.github.io to github.com/gryf/window-maker.github.io.git:gh-pages

Browse Source
This commit is contained in:
Deployment Bot (from Travis CI)
2020-04-06 17:04:05 +00:00
commit 17a465baa1
240 changed files with 23516 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
docs/guidedtour/back.html Normal file
View File

@@ -0,0 +1,173 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Backgrounds and Themes</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="backgrounds-and-themes">
<h1 class="title">Backgrounds and Themes</h1>
<!-- TODO: check for the dead links -->
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#backgrounds" id="id1">Backgrounds</a></p></li>
<li><p><a class="reference internal" href="#styles" id="id2">Styles</a></p></li>
<li><p><a class="reference internal" href="#themes" id="id3">Themes</a></p></li>
</ul>
</div>
<p>For the purposes of this guided tour, only those appearance options that are
built-in to Window Maker will be considered. Crafting custom styles and themes
is not terribly difficult, nor do you need any special knowledge of programming
languages or other specialized skills, but this is outside the intended scope
of the guided tour.</p>
<p>The appearance of the Window Maker GUI can easily be customized from the
applications menu item "Appearance".</p>
<p>Themes, styles, icon sets, and backgrounds can be selected as soon as they are
installed in the right directory.</p>
<p>Themes should be installed in the directory
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Themes/</span></p>
<p>Styles should be installed in the directory
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Styles/</span></p>
<p>Backgrounds should be installed in the directory
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Backgrounds/</span></p>
<p>If you are working within a freshly-installed instance of Window Maker, your
Linux distribution probably provided some default themes, styles and
backgrounds. Rarely, a distribution provides no additional themes, styles or
backgrounds - expecting users to provide these on their own.</p>
<p>Here is the "Appearance" menu and some of its associated sub-menus,
including themes, styles and backgrounds:</p>
<div class="borderless figure">
<img alt="Appearance menu items" src="images/appearancemenu.png">
</div>
<p>In the screenshot above, most of the styles are default to the Debian GNU/Linux
distribution, while most of the themes were user-installed. Many themes are
available for download on the internet.</p>
<div class="section" id="backgrounds">
<h1>Backgrounds</h1>
<p>Backgrounds may be system-generated solid or gradient colors, or they may be
images from user or distribution-supplied image files. The easiest way to
change a system-generated background color or color gradient is to select one
from the "Appearance -&gt; Background -&gt; &lt;Solid | Gradient&gt;" menu. In most default
configurations there will be six to eight selections in each category.</p>
<p>Likewise, the easiest way to change to a background image is to select one from
the "Appearance -&amp;gt; Background -&amp;gt; Images" menu. If you wish to install
your own images for use as backgrounds, place the image file in your
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Backgrounds/</span> directory and they will be
available from the menu immediately.</p>
</div>
<div class="section" id="styles">
<h1>Styles</h1>
<p>A style defines the look of the key components of the Window Maker desktop.
These components include the window titlebar and resizebar, the menu title and
text field, and the icon background.</p>
<p>The characteristics defined in a style (or theme) are the color and "texture"
of key GUI elements. Texture in this context means using multiple colors in
various color gradients - you are not limited to solid colors only.</p>
<p>The easiest method for changing the style is to select a style from the
"Appearance -&gt; Style" menu.</p>
<p>A style may also be created using the <em>Appearance Preferences</em> tool in
<em>WPrefs.app</em>. From this tool, you may configure the color and texture of
window elements (titlebars, resizebars), menu elements (menu titlebar, menu
item text colors, menu "style") and the color and texture of icon backgrounds.
The location of titlebar text and the font and text color for window and menu
text may also be configured here.</p>
<div class="borderless figure">
<img alt="Appearance preferences tool" src="images/prefs13.png">
<p class="caption">Appearance preferences tool</p>
</div>
<p>More information on creating a style "from scratch" may be found <a class="reference external" href="/docs/chap4.html">in the Window
Maker User's Guide</a>. (Scroll down to the
section on "Appearance Options.")</p>
<p>A step-by-step guide to crafting a custom style is available <a class="reference external" href="http://windowmakerandi.blogspot.com/search?updated-min=2011-01-01T00:00:00-06:00&amp;amp;updated-max=2012-01-01T00:00:00-06:00&amp;amp;max-results=4target=%22_blank%22">HERE</a>.</p>
</div>
<div class="section" id="themes">
<h1>Themes</h1>
<p>In its most basic form, a theme is simply a style that also includes a
background. Some Linux distributions provide one or more default themes for use
system-wide. You may install your own themes in the
<span class="docutils literal">~/GNUstep/Library/WindowMaker/Themes/</span> directory. Themes installed in the
correct directory will be available for selection in the "Appearance -&amp;gt;
Themes" menu. Selecting Themes from the Appearance menu runs the <em>setstyle</em>
program to install the theme and record it in the
<span class="docutils literal">~/GNUstep/Defaults/WindowMaker</span> file.</p>
<p>Two sites providing preconfigured themes are <a class="reference external" href="http://lonelymachines.org/windowmaker-themes/">HERE</a> and <a class="reference external" href="http://www.jessanderson.org/wmthemes/">HERE</a>. An internet search for "Window
Maker themes" will generate additional results, and you should also check your
Linux distribution's repositories - some provide themes for installation using
your distribution's package management system.</p>
<p>Themes may include images in png, jpg, xpm, and other supported image file
formats for key elements of the GUI such as titlebars, icon backgrounds, and
the workspace background. Themes that include images cannot be stored as a
single text file, and therefore must be stored in a directory. A theme
directory must contain all of the image files needed for the theme along with a
file named "style." The style file in a theme directory will specify all of the
GUI elements including any image files used for those elements in lieu of rgb
color specifications. A theme directory must use the suffix ".themed" after the
theme name.</p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Backgrounds and Themes</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

194
docs/guidedtour/back.rst Normal file
View File

@@ -0,0 +1,194 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Backgrounds and Themes</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
.. TODO: check for the dead links
Backgrounds and Themes
======================
.. contents::
:backlinks: none
For the purposes of this guided tour, only those appearance options that are
built-in to Window Maker will be considered. Crafting custom styles and themes
is not terribly difficult, nor do you need any special knowledge of programming
languages or other specialized skills, but this is outside the intended scope
of the guided tour.
The appearance of the Window Maker GUI can easily be customized from the
applications menu item "Appearance".
Themes, styles, icon sets, and backgrounds can be selected as soon as they are
installed in the right directory.
Themes should be installed in the directory
``~/GNUstep/Library/WindowMaker/Themes/``
Styles should be installed in the directory
``~/GNUstep/Library/WindowMaker/Styles/``
Backgrounds should be installed in the directory
``~/GNUstep/Library/WindowMaker/Backgrounds/``
If you are working within a freshly-installed instance of Window Maker, your
Linux distribution probably provided some default themes, styles and
backgrounds. Rarely, a distribution provides no additional themes, styles or
backgrounds - expecting users to provide these on their own.
Here is the "Appearance" menu and some of its associated sub-menus,
including themes, styles and backgrounds:
.. figure:: images/appearancemenu.png
:alt: Appearance menu items
:figclass: borderless
In the screenshot above, most of the styles are default to the Debian GNU/Linux
distribution, while most of the themes were user-installed. Many themes are
available for download on the internet.
Backgrounds
-----------
Backgrounds may be system-generated solid or gradient colors, or they may be
images from user or distribution-supplied image files. The easiest way to
change a system-generated background color or color gradient is to select one
from the "Appearance -> Background -> <Solid | Gradient>" menu. In most default
configurations there will be six to eight selections in each category.
Likewise, the easiest way to change to a background image is to select one from
the "Appearance -&gt; Background -&gt; Images" menu. If you wish to install
your own images for use as backgrounds, place the image file in your
``~/GNUstep/Library/WindowMaker/Backgrounds/`` directory and they will be
available from the menu immediately.
Styles
------
A style defines the look of the key components of the Window Maker desktop.
These components include the window titlebar and resizebar, the menu title and
text field, and the icon background.
The characteristics defined in a style (or theme) are the color and "texture"
of key GUI elements. Texture in this context means using multiple colors in
various color gradients - you are not limited to solid colors only.
The easiest method for changing the style is to select a style from the
"Appearance -> Style" menu.
A style may also be created using the *Appearance Preferences* tool in
*WPrefs.app*. From this tool, you may configure the color and texture of
window elements (titlebars, resizebars), menu elements (menu titlebar, menu
item text colors, menu "style") and the color and texture of icon backgrounds.
The location of titlebar text and the font and text color for window and menu
text may also be configured here.
.. figure:: images/prefs13.png
:figclass: borderless
:alt: Appearance preferences tool
Appearance preferences tool
More information on creating a style "from scratch" may be found `in the Window
Maker User's Guide </docs/chap4.html>`_. (Scroll down to the
section on "Appearance Options.")
A step-by-step guide to crafting a custom style is available `HERE
<http://windowmakerandi.blogspot.com/search?updated-min=2011-01-01T00:00:00-06:00&amp;updated-max=2012-01-01T00:00:00-06:00&amp;max-results=4
target="_blank">`__.
Themes
------
In its most basic form, a theme is simply a style that also includes a
background. Some Linux distributions provide one or more default themes for use
system-wide. You may install your own themes in the
``~/GNUstep/Library/WindowMaker/Themes/`` directory. Themes installed in the
correct directory will be available for selection in the "Appearance -&gt;
Themes" menu. Selecting Themes from the Appearance menu runs the *setstyle*
program to install the theme and record it in the
``~/GNUstep/Defaults/WindowMaker`` file.
Two sites providing preconfigured themes are `HERE
<http://lonelymachines.org/windowmaker-themes/>`__ and `HERE
<http://www.jessanderson.org/wmthemes/>`__. An internet search for "Window
Maker themes" will generate additional results, and you should also check your
Linux distribution's repositories - some provide themes for installation using
your distribution's package management system.
Themes may include images in png, jpg, xpm, and other supported image file
formats for key elements of the GUI such as titlebars, icon backgrounds, and
the workspace background. Themes that include images cannot be stored as a
single text file, and therefore must be stored in a directory. A theme
directory must contain all of the image files needed for the theme along with a
file named "style." The style file in a theme directory will specify all of the
GUI elements including any image files used for those elements in lieu of rgb
color specifications. A theme directory must use the suffix ".themed" after the
theme name.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Backgrounds and Themes</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

153
docs/guidedtour/clip.html Normal file
View File

@@ -0,0 +1,153 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Clip</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="clip">
<h1 class="title">CLIP</h1>
<p>By default, The clip is represented by the icon on the top left of the screen
containing a paperclip image.</p>
<div class="borderless figure">
<img alt="Clip icon" src="images/clip.png">
</div>
<p>The clip's primary function is to serve as a workspace-specific dock. In other
words, applications may be attached to the clip just as they are to the dock,
but the clip and its associated applications are specific to each individual
workspace - not available on all workspaces as they are on the dock.</p>
<p>The clip's secondary function is to act as a "pager" - a utility for changing
from one workspace to another (paging). The arrows at the top right and bottom
left corners of the clip icon allow you to switch from one workspace to the
next workspace (top right) or previous workspace (bottom left).</p>
<p>The current workspace name (if any) and number are displayed on the
clip.</p>
<p>The clip also has a number of menu-driven features.</p>
<div class="section" id="clip-menu">
<h1>Clip Menu</h1>
<p>Right-clicking the clip displays a menu.</p>
<div class="borderless figure">
<img alt="Clip menu" src="images/menu_clip.png">
<p class="caption">Clip menu</p>
</div>
</div>
<div class="section" id="clip-options">
<h1>Clip Options</h1>
<p>The first menu item allows you to select clip options. The following options
are available:</p>
<ul class="simple">
<li><p><em>Keep on top</em> - do not allow windows to cover the clip.</p></li>
<li><p><em>Collapsed</em> - icons attached to the clip are hidden until you left-click the
clip, which unhides them.</p></li>
<li><p><em>Autocollapse</em> - same as the previous option, except that mouseing over the
clip unhides application icons.</p></li>
<li><p><em>Autoraise</em> - clicking an icon representing a window hidden under a larger
window brings that window to the front.</p></li>
<li><p><em>Autoattract icons</em> - selecting this option attracts the icon of any
application launched on the current workspace. Closing the application
removes the icon from the clip.</p></li>
</ul>
</div>
<div class="section" id="rename-workspace">
<h1>Rename Workspace</h1>
<p>This item gives you to ability to name (or rename) the current workspace.</p>
<p>Some users tend to group certain applications by workspace and like to name the
workspace to indicate the nature of the applications on the clip. For example,
a user might have a browser, an IRC client, and a file transfer application
clipped on a workspace, and might name that workspace "internet" to indicate
the workspace's primary function. The user might have a seperate workspace with
a vector graphics application, an image manipulation application, and an image
viewer on the clip, and might name that workspace "graphics."</p>
</div>
<div class="section" id="other-options">
<h1>Other Options</h1>
<p>Right-clicking a clipped application's icon gives options specific to that
application.</p>
<ul class="simple">
<li><p>You may make the application's icon <em>omnipresent</em> (clipped on all
workspaces).</p></li>
<li><p>You may <em>select</em> one or all clipped icons.</p></li>
<li><p>You may <em>move</em> one or all icons to a different workspace.</p></li>
<li><p>You may <em>remove</em> the icon.</p></li>
<li><p>You may instruct Window Maker to have all icons <em>attracted</em> to the clip as
soon as each application is launched, rather than placing them initially in
the defined location on the display.</p></li>
</ul>
<p>The remaining clip menu items are similar to those of the <a class="reference external" href="dock.html#conf">Dock application
icon menu</a>. As with the dock, clipped applications may be
launched, hidden, or killed and their settings (icon used, application launch
path/arguments, middle-click launch) may be modified.</p>
<p>From version 0.80.0 on, the clip can "steal" appicons. This feature has nothing
to do with autoattracting icons. When you start an application from somewhere
other than either the clip or the dock (i.e., from the menu or a terminal), and
the application is already either docked or clipped, a new application icon
does not appear at the bottom of your screen. The icon that is already docked
or clipped "steals" the icon function. As a result, the icon for the
newly-launched application is the icon already on the clip or the dock.</p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Clip</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

167
docs/guidedtour/clip.rst Normal file
View File

@@ -0,0 +1,167 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Clip</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
CLIP
====
By default, The clip is represented by the icon on the top left of the screen
containing a paperclip image.
.. figure:: images/clip.png
:alt: Clip icon
:figclass: borderless
The clip's primary function is to serve as a workspace-specific dock. In other
words, applications may be attached to the clip just as they are to the dock,
but the clip and its associated applications are specific to each individual
workspace - not available on all workspaces as they are on the dock.
The clip's secondary function is to act as a "pager" - a utility for changing
from one workspace to another (paging). The arrows at the top right and bottom
left corners of the clip icon allow you to switch from one workspace to the
next workspace (top right) or previous workspace (bottom left).
The current workspace name (if any) and number are displayed on the
clip.
The clip also has a number of menu-driven features.
Clip Menu
---------
Right-clicking the clip displays a menu.
.. figure:: images/menu_clip.png
:alt: Clip menu
:figclass: borderless
Clip menu
Clip Options
------------
The first menu item allows you to select clip options. The following options
are available:
- *Keep on top* - do not allow windows to cover the clip.
- *Collapsed* - icons attached to the clip are hidden until you left-click the
clip, which unhides them.
- *Autocollapse* - same as the previous option, except that mouseing over the
clip unhides application icons.
- *Autoraise* - clicking an icon representing a window hidden under a larger
window brings that window to the front.
- *Autoattract icons* - selecting this option attracts the icon of any
application launched on the current workspace. Closing the application
removes the icon from the clip.
Rename Workspace
----------------
This item gives you to ability to name (or rename) the current workspace.
Some users tend to group certain applications by workspace and like to name the
workspace to indicate the nature of the applications on the clip. For example,
a user might have a browser, an IRC client, and a file transfer application
clipped on a workspace, and might name that workspace "internet" to indicate
the workspace's primary function. The user might have a seperate workspace with
a vector graphics application, an image manipulation application, and an image
viewer on the clip, and might name that workspace "graphics."
Other Options
-------------
Right-clicking a clipped application's icon gives options specific to that
application.
- You may make the application's icon *omnipresent* (clipped on all
workspaces).
- You may *select* one or all clipped icons.
- You may *move* one or all icons to a different workspace.
- You may *remove* the icon.
- You may instruct Window Maker to have all icons *attracted* to the clip as
soon as each application is launched, rather than placing them initially in
the defined location on the display.
The remaining clip menu items are similar to those of the `Dock application
icon menu <dock.html#conf>`_. As with the dock, clipped applications may be
launched, hidden, or killed and their settings (icon used, application launch
path/arguments, middle-click launch) may be modified.
From version 0.80.0 on, the clip can "steal" appicons. This feature has nothing
to do with autoattracting icons. When you start an application from somewhere
other than either the clip or the dock (i.e., from the menu or a terminal), and
the application is already either docked or clipped, a new application icon
does not appear at the bottom of your screen. The icon that is already docked
or clipped "steals" the icon function. As a result, the icon for the
newly-launched application is the icon already on the clip or the dock.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Clip</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

177
docs/guidedtour/dock.html Normal file
View File

@@ -0,0 +1,177 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Dock</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="dock">
<h1 class="title">Dock</h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#application-dock" id="id1">Application dock</a></p></li>
<li><p><a class="reference internal" href="#starting-an-application" id="id2">Starting an application</a></p></li>
<li><p><a class="reference internal" href="#customizing" id="id3">Customizing</a></p></li>
<li><p><a class="reference internal" href="#configuring" id="id4">Configuring</a></p></li>
</ul>
</div>
<div class="section" id="application-dock">
<h1>Application dock</h1>
<p>The dock is the column of icons located by default on the right side of the
screen.</p>
<p>Any application can be attached to the dock. To do this, open an application
then simply left-click-and-drag the application's icon to the last position on
the dock. The dock will "attract" the icon and it will remain on the dock until
removed by the user (left-click-and-drag the icon off the dock - it will
disappear.) If you have saved your Window Maker session prior to logout (or set
Window Maker to autosave your session upon logout) any icons you docked will
automatically reappear at your next - and each subsequent - session.</p>
<p>The dock can be configured to remain on top of maximized windows. To do this,
right-click on a dock or any docked icon then select appropriate option form
<em>Dock position</em> submenu. Consult <a class="reference external" href="menu.html#application-icon-menu">Application icon menu</a> for details.</p>
<p>The WMDock icon (by default, with the GNUstep logo) can be dragged sideways to
switch the the entire dock from one side of the display to the other.</p>
<p>Dragging the WMDock icon downward will move the dock off the display with the
exception of the WMDock icon itself, which will remain visible. To restore dock
visibility, left-click-and-drag the dock back on screen.</p>
</div>
<div class="section" id="starting-an-application">
<h1>Starting an application</h1>
<p>Double-clicking the icon of a docked application starts the application.</p>
<p>An application that has not been launched normally has an elipsis (three dots)
in the bottom-left-corner of the icon and appears in full color as shown below.</p>
<div class="borderless figure">
<img alt="Unlaunched application icon" src="images/unlaunched_app.png">
<p class="caption">Unlaunched application icon</p>
</div>
<p>When the application is running, the elipsis disappears from the
bottom-left-corner of the icon and the icon becomes highlited.</p>
<div class="borderless figure">
<img alt="Launched application icon" src="images/launched_app.png">
<p class="caption">Launched application icon</p>
</div>
<p>Sometimes, when the application is running, instead of highlited icon, the icon
becomes "greyed out", giving a visual cue that the application is already open,
and cannot be launched again.</p>
<div class="borderless figure">
<img alt="Launched application icon" src="images/grayed_out_icon.png">
<p class="caption">Grayed-out application icon</p>
</div>
<p>A docked icon that continues to show an elipsis and remains "full color" even
after an instance of the application is running indicates that the
application's settings have been modified to allow multiple launches from one
docked icon. To do this you must open the application and modify the
"application specific" settings in the <a class="reference external" href="win.html#menu">commands menu</a> of the
application to allow "shared application icons".</p>
<p>Using the "launch" command in the "application icon menu" for the icon is
another way to start an application from the dock.</p>
<p>From version 0.80.0 on, the dock can "steal" appicons. This feature has nothing
to do with Autoattract Icons. When you start an application from somewhere else
than either the clip or the dock (menu or terminal), and the appicon exists in
one of them (clip or dock), this appicon doesn't appear at the bottom of your
screen. The appicon existing in the clip or the dock "stole" it. As a result,
the appicon is the same as the one used to start the application from the clip
or the dock.</p>
</div>
<div class="section" id="customizing">
<h1>Customizing</h1>
<p>Left-clicking and dragging an application icon to the dock adds this
application to the dock. Obviously, this means the application is running!</p>
<p><em>Miniwindows</em> (windows of minimized applications) cannot be docked. The small
titlebar on the miniwindow differentiates it from an application's icon.</p>
<p>Dragging an icon off the dock removes the docked application.</p>
</div>
<div class="section" id="configuring">
<h1>Configuring</h1>
<p>There is a dock menu for each icon. Right-clicking the icon displays the
"application icon menu". Select the "Settings..." option to configure the
application.</p>
<div class="borderless figure">
<img alt="Launched application icon" src="images/docked_application_settings.png">
<p class="caption">Launched application icon</p>
</div>
<p>The application's <em>path</em> and its arguments, the command for middle-click
launch, and the icon employed can be changed in this panel.</p>
<p>Shell commands such as redirection cannot be used in the command field.</p>
<p>The desired icon must be in one of the directories displayed in the panel while
browsing. New directories can be added from the <a class="reference external" href="prefs.html#search-path">Search path preferences</a>.</p>
<p>A checkbox allows you to start the application when Window Maker is first
started. (Note: <em>You want to be careful with this</em>. If you have, for example,
your terminal emulator, your file manager, and your browser set to start when
Window Maker is started you'll get an open terminal, an open file manager and
an open browser <em>every time</em> you start a session! Normally you will only want
to start certain dockapps - "regular" applications like a terminal emulator or
browser can be started <em>after</em> your session is up and going.)</p>
<p>From version 0.62.0 on, a checkbox can be used to prevent accidental
removal from the dock.</p>
<p>From version 0.70.0 on, a new field has been added for middle-click launch.
Entering, for example, "firefox" into a docked application settings panel will
launch the Firefox browser.</p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Dock</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

200
docs/guidedtour/dock.rst Normal file
View File

@@ -0,0 +1,200 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Dock</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Dock
====
.. contents::
:backlinks: none
Application dock
----------------
The dock is the column of icons located by default on the right side of the
screen.
Any application can be attached to the dock. To do this, open an application
then simply left-click-and-drag the application's icon to the last position on
the dock. The dock will "attract" the icon and it will remain on the dock until
removed by the user (left-click-and-drag the icon off the dock - it will
disappear.) If you have saved your Window Maker session prior to logout (or set
Window Maker to autosave your session upon logout) any icons you docked will
automatically reappear at your next - and each subsequent - session.
The dock can be configured to remain on top of maximized windows. To do this,
right-click on a dock or any docked icon then select appropriate option form
*Dock position* submenu. Consult `Application icon menu
<menu.html#application-icon-menu>`_ for details.
The WMDock icon (by default, with the GNUstep logo) can be dragged sideways to
switch the the entire dock from one side of the display to the other.
Dragging the WMDock icon downward will move the dock off the display with the
exception of the WMDock icon itself, which will remain visible. To restore dock
visibility, left-click-and-drag the dock back on screen.
Starting an application
-----------------------
Double-clicking the icon of a docked application starts the application.
An application that has not been launched normally has an elipsis (three dots)
in the bottom-left-corner of the icon and appears in full color as shown below.
.. figure:: images/unlaunched_app.png
:alt: Unlaunched application icon
:figclass: borderless
Unlaunched application icon
When the application is running, the elipsis disappears from the
bottom-left-corner of the icon and the icon becomes highlited.
.. figure:: images/launched_app.png
:alt: Launched application icon
:figclass: borderless
Launched application icon
Sometimes, when the application is running, instead of highlited icon, the icon
becomes "greyed out", giving a visual cue that the application is already open,
and cannot be launched again.
.. figure:: images/grayed_out_icon.png
:alt: Launched application icon
:figclass: borderless
Grayed-out application icon
A docked icon that continues to show an elipsis and remains "full color" even
after an instance of the application is running indicates that the
application's settings have been modified to allow multiple launches from one
docked icon. To do this you must open the application and modify the
"application specific" settings in the `commands menu <win.html#menu>`_ of the
application to allow "shared application icons".
Using the "launch" command in the "application icon menu" for the icon is
another way to start an application from the dock.
From version 0.80.0 on, the dock can "steal" appicons. This feature has nothing
to do with Autoattract Icons. When you start an application from somewhere else
than either the clip or the dock (menu or terminal), and the appicon exists in
one of them (clip or dock), this appicon doesn't appear at the bottom of your
screen. The appicon existing in the clip or the dock "stole" it. As a result,
the appicon is the same as the one used to start the application from the clip
or the dock.
Customizing
-----------
Left-clicking and dragging an application icon to the dock adds this
application to the dock. Obviously, this means the application is running!
*Miniwindows* (windows of minimized applications) cannot be docked. The small
titlebar on the miniwindow differentiates it from an application's icon.
Dragging an icon off the dock removes the docked application.
Configuring
-----------
There is a dock menu for each icon. Right-clicking the icon displays the
"application icon menu". Select the "Settings..." option to configure the
application.
.. figure:: images/docked_application_settings.png
:alt: Launched application icon
:figclass: borderless
Launched application icon
The application's *path* and its arguments, the command for middle-click
launch, and the icon employed can be changed in this panel.
Shell commands such as redirection cannot be used in the command field.
The desired icon must be in one of the directories displayed in the panel while
browsing. New directories can be added from the `Search path preferences
<prefs.html#search-path>`_.
A checkbox allows you to start the application when Window Maker is first
started. (Note: *You want to be careful with this*. If you have, for example,
your terminal emulator, your file manager, and your browser set to start when
Window Maker is started you'll get an open terminal, an open file manager and
an open browser *every time* you start a session! Normally you will only want
to start certain dockapps - "regular" applications like a terminal emulator or
browser can be started *after* your session is up and going.)
From version 0.62.0 on, a checkbox can be used to prevent accidental
removal from the dock.
From version 0.70.0 on, a new field has been added for middle-click launch.
Entering, for example, "firefox" into a docked application settings panel will
launch the Firefox browser.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Dock</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

BIN
docs/guidedtour/images/GNUstep.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.5 KiB

BIN
docs/guidedtour/images/LogoGNUstep.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/guidedtour/images/apm.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 9.9 KiB

BIN
docs/guidedtour/images/appearancemenu.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 215 KiB

BIN
docs/guidedtour/images/clip.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.6 KiB

BIN
docs/guidedtour/images/dde.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 366 B

BIN
docs/guidedtour/images/den.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.3 KiB

BIN
docs/guidedtour/images/des.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 658 B

BIN
docs/guidedtour/images/dfr.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 817 B

BIN
docs/guidedtour/images/dock_tile.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.6 KiB

BIN
docs/guidedtour/images/docked_application_settings.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
docs/guidedtour/images/dockm.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.4 KiB

BIN
docs/guidedtour/images/gnustep_64.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.0 KiB

BIN
docs/guidedtour/images/gnusteplogo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/guidedtour/images/gnusteplogo2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

BIN
docs/guidedtour/images/grayed_out_icon.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.0 KiB

BIN
docs/guidedtour/images/greyedouticon.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.8 KiB

BIN
docs/guidedtour/images/header.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.1 KiB

BIN
docs/guidedtour/images/launched_app.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.7 KiB

BIN
docs/guidedtour/images/menu_application_icon.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.4 KiB

BIN
docs/guidedtour/images/menu_applications.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.6 KiB

BIN
docs/guidedtour/images/menu_clip.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.1 KiB

BIN
docs/guidedtour/images/menu_window_list.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.6 KiB

BIN
docs/guidedtour/images/menu_workspaces.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.0 KiB

BIN
docs/guidedtour/images/panda.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 91 KiB

BIN
docs/guidedtour/images/panda2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 91 KiB

BIN
docs/guidedtour/images/panda3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.3 KiB

BIN
docs/guidedtour/images/prefs0.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
docs/guidedtour/images/prefs1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 34 KiB

BIN
docs/guidedtour/images/prefs10.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

BIN
docs/guidedtour/images/prefs11.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

BIN
docs/guidedtour/images/prefs12.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

BIN
docs/guidedtour/images/prefs13.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 56 KiB

BIN
docs/guidedtour/images/prefs14.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 35 KiB

BIN
docs/guidedtour/images/prefs15.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

BIN
docs/guidedtour/images/prefs2.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/guidedtour/images/prefs3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
docs/guidedtour/images/prefs4.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/guidedtour/images/prefs5.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 31 KiB

BIN
docs/guidedtour/images/prefs6.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 36 KiB

BIN
docs/guidedtour/images/prefs7.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 43 KiB

BIN
docs/guidedtour/images/prefs8.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

BIN
docs/guidedtour/images/prefs9.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 42 KiB

BIN
docs/guidedtour/images/shadew.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.0 KiB

BIN
docs/guidedtour/images/unlaunched_app.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.1 KiB

BIN
docs/guidedtour/images/wadvopt.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/guidedtour/images/wapspec.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

BIN
docs/guidedtour/images/watt.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
docs/guidedtour/images/wicon.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

BIN
docs/guidedtour/images/wl.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.2 KiB

BIN
docs/guidedtour/images/wmakercomponents.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 554 KiB

BIN
docs/guidedtour/images/wmakerconf.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.7 KiB

BIN
docs/guidedtour/images/wprefs.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.4 KiB

BIN
docs/guidedtour/images/wspec.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

146
docs/guidedtour/index.html Normal file
View File

@@ -0,0 +1,146 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Index</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="window-maker">
<h1 class="title">Window Maker</h1>
<div class="center section" id="guided-tour">
<h1>Guided Tour</h1>
<img alt="images/gnusteplogo.png" class="screenshot center" src="images/gnusteplogo.png" style="width: 100px; height: 100px;">
</div>
<div class="section" id="foreword">
<h1>Foreword</h1>
<p>This tutorial is intended to help Window Maker users gain knowledge about the
many excellent features of this window manager. The official Users Guide is
worth reading. It can be reached from the <a class="reference external" href="/docs/guide_toc.html">Window Maker site</a>. Other guides, tutorials and tips can be found at
various sites on the internet. An internet search for "Window Maker guide
how-to" might provide additional worthwhile information.</p>
<p>This guided tour is NOT supposed to be a README, INSTALL or FAQ. These are
worth reading, or more accurately, they should be considered COMPULSORY
reading.</p>
<p>The information in the guided tour is based upon Window Maker version 0.95.3.
Check your version by opening WPrefs.app (the Window Maker Preferences tool).
The version number is shown in the initial WPrefs window just below the "Window
Maker Preferences" title. You may also run the command "<em>wmaker --version</em>" in
a terminal (without the quotation marks). This command returns the installed
version number of Window Maker.</p>
</div>
<div class="section" id="a-special-word-of-thanks">
<h1>A special word of thanks</h1>
<p>The original Window Maker Guided Tour site was created and maintained for many
years by Georges Tarbouriech. Where possible, I have retained his original
work - including the layout and structure of the pages, the descriptions of
Window Maker features, and even some of his original graphics. I want these
pages to be up-to-date, but I also want them to be (as much as possible) a
continuation of Georges' work. <em>Thank you, Georges</em>. (Having said that,
anything you find in error is without question my fault - so don't blame
Georges for any mistakes!) If you find an error, have a suggestion, or wish to
make a comment, you may contact me by email at
<em>bnance&amp;lt;atsigngoeshere&amp;gt;uu.edu</em>.</p>
<p>This tour will attempt to follow Window Maker development, but not
every update can be taken into account. In other words, this
tour can help you learn the basics, but does not pretend to provide all
of the detail or all of the latest information available in the
official README, INSTALL and FAQ documents provided by Window Maker
developers and maintainers.</p>
<div class="section" id="table-of-contents">
<h2>Table of contents</h2>
<ul class="contents simple">
<li><p><a class="reference external" href="prefs.html">Preferences</a></p></li>
<li><p><a class="reference external" href="win.html">Windows</a></p></li>
<li><p><a class="reference external" href="menu.html">Menus</a></p></li>
<li><p><a class="reference external" href="dock.html">Dock</a></p></li>
<li><p><a class="reference external" href="clip.html">Clip</a></p></li>
<li><p><a class="reference external" href="back.html">Backgrounds and themes</a></p></li>
<li><p><a class="reference external" href="misc.html">Miscellaneous</a></p></li>
</ul>
</div>
</div>
<div class="section" id="archives">
<h1>Archives</h1>
<p>Two archives are available: HTML and pictures.</p>
<!-- TODO: figure out what's the status of those archives. -->
<ul class="simple">
<li><p><a class="reference external" href="tut.tar.gz">tut.tar.gz (12K) HTML files</a></p></li>
<li><p><a class="reference external" href="img.tar.gz">img.tar.gz (613K) Picture files</a></p></li>
</ul>
</div>
<div class="section" id="links-of-interest">
<h1>Links of interest</h1>
<ul class="simple">
<li><p><a class="reference external" href="https://www.youtube.com/watch?v=dIkbxMbhBpc">Window Maker on Debian 6 (YouTube)</a> by fourandnine</p></li>
<li><p><a class="reference external" href="https://wiki.archlinux.org/index.php/Window_Maker">Arch Linux Window Maker Wiki Entry</a></p></li>
<li><p><a class="reference external" href="http://packages.debian.org/squeeze/wmaker">Debian Stable (Squeeze) Package Listing</a></p></li>
<li><p><a class="reference external" href="http://www.youtube.com/watch?v=T7VFjW8p9NU">Window Maker on Mageia Linux (YouTube)</a> by St. Louis Mageia Users' Group</p></li>
</ul>
<p class="center"><a class="reference external" href="http://www.windowmaker.org">Window Maker</a></p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Index</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

164
docs/guidedtour/index.rst Normal file
View File

@@ -0,0 +1,164 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Index</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Window Maker
============
.. class:: center
Guided Tour
-----------
.. class:: screenshot center
.. image:: images/gnusteplogo.png
:height: 100
:width: 100
Foreword
--------
This tutorial is intended to help Window Maker users gain knowledge about the
many excellent features of this window manager. The official Users Guide is
worth reading. It can be reached from the `Window Maker site </docs/guide_toc.html>`_. Other guides, tutorials and tips can be found at
various sites on the internet. An internet search for "Window Maker guide
how-to" might provide additional worthwhile information.
This guided tour is NOT supposed to be a README, INSTALL or FAQ. These are
worth reading, or more accurately, they should be considered COMPULSORY
reading.
The information in the guided tour is based upon Window Maker version 0.95.3.
Check your version by opening WPrefs.app (the Window Maker Preferences tool).
The version number is shown in the initial WPrefs window just below the "Window
Maker Preferences" title. You may also run the command "*wmaker --version*" in
a terminal (without the quotation marks). This command returns the installed
version number of Window Maker.
A special word of thanks
------------------------
The original Window Maker Guided Tour site was created and maintained for many
years by Georges Tarbouriech. Where possible, I have retained his original
work - including the layout and structure of the pages, the descriptions of
Window Maker features, and even some of his original graphics. I want these
pages to be up-to-date, but I also want them to be (as much as possible) a
continuation of Georges' work. *Thank you, Georges*. (Having said that,
anything you find in error is without question my fault - so don't blame
Georges for any mistakes!) If you find an error, have a suggestion, or wish to
make a comment, you may contact me by email at
*bnance&lt;atsigngoeshere&gt;uu.edu*.
This tour will attempt to follow Window Maker development, but not
every update can be taken into account. In other words, this
tour can help you learn the basics, but does not pretend to provide all
of the detail or all of the latest information available in the
official README, INSTALL and FAQ documents provided by Window Maker
developers and maintainers.
Table of contents
~~~~~~~~~~~~~~~~~
.. class:: contents
- `Preferences <prefs.html>`_
- `Windows <win.html>`_
- `Menus <menu.html>`_
- `Dock <dock.html>`_
- `Clip <clip.html>`_
- `Backgrounds and themes <back.html>`_
- `Miscellaneous <misc.html>`_
Archives
--------
Two archives are available: HTML and pictures.
.. TODO: figure out what's the status of those archives.
- `tut.tar.gz (12K) HTML files <tut.tar.gz>`_
- `img.tar.gz (613K) Picture files <img.tar.gz>`_
Links of interest
-----------------
- `Window Maker on Debian 6 (YouTube)
<https://www.youtube.com/watch?v=dIkbxMbhBpc>`_ by fourandnine
- `Arch Linux Window Maker Wiki Entry
<https://wiki.archlinux.org/index.php/Window_Maker>`_
- `Debian Stable (Squeeze) Package Listing
<http://packages.debian.org/squeeze/wmaker>`_
- `Window Maker on Mageia Linux (YouTube)
<http://www.youtube.com/watch?v=T7VFjW8p9NU>`_ by St. Louis Mageia Users' Group
.. class:: center
`Window Maker <http://www.windowmaker.org>`_
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Index</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

208
docs/guidedtour/menu.html Normal file
View File

@@ -0,0 +1,208 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Menus</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="menus">
<h1 class="title">Menus</h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#menu-list" id="id1">Menu list</a></p></li>
<li><p><a class="reference internal" href="#root-window-menu" id="id2">Root window menu</a></p></li>
<li><p><a class="reference internal" href="#window-list-menu" id="id3">Window list menu</a></p></li>
<li><p><a class="reference internal" href="#workspaces-menu" id="id4">Workspaces menu</a></p></li>
<li><p><a class="reference internal" href="#application-icon-menu" id="id5">Application icon menu</a></p></li>
</ul>
</div>
<div class="section" id="menu-list">
<h1>Menu list</h1>
<p>Different menus are available within Window Maker:</p>
<ul class="simple">
<li><p>The root window menu or applications menu</p></li>
<li><p>The window list menu</p></li>
<li><p>The workspace menu</p></li>
<li><p>The application icon menu</p></li>
</ul>
<p>Menus provide a list of applications or commands for execution. They can be
used to launch applications, to get information, to configure the workspace...</p>
<p>Menus are opened by right-clicking either in the "blank" area of the workspace
or in a window's titlebar or in docked icons. The <em>window list menu</em> is the
only one opened with the middle mouse button. With a two-button mouse,
pressing both buttons at once usually does the trick. A number of keyboard
shortcuts are provided. These shortcuts are indicated by the modifier key +
letter shown to the right of a menu item.</p>
<p>The keyboard can be used to open and move through some of the menus. For
instance, the root menu can be opened using F12 (default setting). The Up and
Down arrow keys can then be used to navigate through the menu or the Left and
Right arrow keys to jump between parent menus and submenus. Hitting the <em>Enter</em>
key executes the selected item. The <em>Escape</em> key closes the menu or stops menu
traversal.</p>
<p>Menus can be forced to remain open on the workspace by left-clicking the
titlebar. This creates a <em>close</em> button on the titlebar.</p>
</div>
<div class="section" id="root-window-menu">
<h1>Root window menu</h1>
<div class="borderless figure">
<img alt="Root window menu (applications menu)" src="images/menu_applications.png">
<p class="caption">Root window menu (applications menu)</p>
</div>
<p>The root window menu or applications menu is opened by right-clicking on an
empty area of the workspace or by hitting the pre-defined keyboard shortcut
(default is F12). This menu launches applications, allows for the customization
of the workspace (backgrounds, themes...), and the management of other
workspace characteristics using standard X utilities (xprop, xfontsel,
xcmap...).</p>
<p>The menu content is totally configurable, either using WPrefs.app or by editing
the plain text menu file. Instructions on how to configure one or the other can
be found in the WindowMaker directory of the distribution. To use WPrefs.app,
menus must be in property list format (plmenu). A script is available to
convert plain text menus to property list menus and it's called wm-oldmenu2new.</p>
</div>
<div class="section" id="window-list-menu">
<h1>Window list menu</h1>
<div class="borderless figure">
<img alt="Window list menu" src="images/menu_window_list.png">
<p class="caption">Window list menu</p>
</div>
<p>Middle-clicking an empty area of the workspace opens the window list menu. With
a two-button mouse, clicking both buttons at once usually gives the same
result. F11 is the default keyboard shortcut to open the window list menu.</p>
<p>This menu lists all windows - whether active or inactive - in every workspace.
The workspace containing each window is indicated at the right of the window
name. The current focused window is marked by a diamond sign to the left of the
window's name. Clicking any window in the list focuses and raises the
corresponding window and moves you to the workspace where it's located.</p>
</div>
<div class="section" id="workspaces-menu">
<h1>Workspaces menu</h1>
<div class="borderless figure">
<img alt="Workspaces menu" src="images/menu_workspaces.png">
<p class="caption">Workspaces menu</p>
</div>
<p>The workspaces menu is part of the root menu (applications menu). This item
has three options: <em>new</em>, <em>destroy last</em> and <em>last used</em>.</p>
<p>The first option creates a new workspace and automatically switches you to it.</p>
<p>The second option destroys the last workspace as soon as there are no windows
opened in it.</p>
<p>The third option switches to last visited workspace.</p>
<p>Each workspace has a corresponding item in this menu. The active workspace is
indicated by a diamond to the left of the workspace name or number.</p>
<p>Clicking a workspace entry switches from the current workspace to the selected
workspace.</p>
<p>To change the name of a workspace, first "stick" the menu by left-clicking the
menu titlebar. Then <em>Ctrl + click</em> the menu item to make it editable and type
in the new name. Hitting <em>Return</em> saves the new name, hitting <em>Escape</em> cancels
the operation.</p>
<p>Key bindings allow movement from one workspace to another. Usually <em>Meta +
(number)</em>. The <em>Meta</em> key is normally the "<em>Alt</em>" key, while <em>(number)</em>
represents a number key that corresponds to the workspace number. For instance
1 can be the default workspace (workspace 1), 2 the second workspace and so on.
Thus, <em>Meta + 2</em> switches to workspace 2.</p>
<p>These key bindings can be set (or changed) from the keyboard shortcut dialog in
WPrefs.app.</p>
</div>
<div class="section" id="application-icon-menu">
<h1>Application icon menu</h1>
<div class="borderless figure">
<img alt="Icon application menu" src="images/menu_application_icon.png">
<p class="caption">Icon application menu</p>
</div>
<p>Clicking an icon in the dock with the right mouse button brings a menu for
modifying that icon's application. There are several options available in the
application icon menu for docked applications. Docked, but not running
applications will not have all options available - they will appear "greyed
out" in the menu.</p>
<ol class="arabic simple">
<li>
<p>First option is a global Dock submenu, which have three items:</p>
<ol class="arabic simple">
<li><p><em>Normal</em> will not change dock behaviour - it can be covered by windows,
while clicking on any docked items will bring it up.</p></li>
<li><p><em>Auto raise &amp; lower</em> is similar for the first options, although you don't
have to click on dock - it's enough to hover mouse pointer on visible
part of dock or it's items.</p></li>
<li><p><em>Keep on top</em> means that the dock will always be on "top" of opened
windows.</p></li>
</ol>
</li>
<li><p><em>Add a drawer</em> will add special dockapp which can be used for aggregating
applications. See <a class="reference external" href="dock.html">Dock</a> for more details about drawers.</p></li>
<li><p>"Launch" opens the application without double-clicking the icon.</p></li>
<li><p>"Bring here" unhides the application in the current workspace.</p></li>
<li><p>"Hide" hides the application or unhides it if already hidden. Unhiding opens
the application in the workspace where it is located. (This option may not
work if the application has it's own hiding menu option.)</p></li>
<li><p>"Settings" allows the modification of application path and arguments, the
command line, and the icon used.</p></li>
<li><p>"Kill" closes the application immediately and should only be used if
absolutely necessary.</p></li>
</ol>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Menus</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

233
docs/guidedtour/menu.rst Normal file
View File

@@ -0,0 +1,233 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Menus</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Menus
=====
.. contents::
:depth: 1
:backlinks: none
:local:
Menu list
---------
Different menus are available within Window Maker:
- The root window menu or applications menu
- The window list menu
- The workspace menu
- The application icon menu
Menus provide a list of applications or commands for execution. They can be
used to launch applications, to get information, to configure the workspace...
Menus are opened by right-clicking either in the "blank" area of the workspace
or in a window's titlebar or in docked icons. The *window list menu* is the
only one opened with the middle mouse button. With a two-button mouse,
pressing both buttons at once usually does the trick. A number of keyboard
shortcuts are provided. These shortcuts are indicated by the modifier key +
letter shown to the right of a menu item.
The keyboard can be used to open and move through some of the menus. For
instance, the root menu can be opened using F12 (default setting). The Up and
Down arrow keys can then be used to navigate through the menu or the Left and
Right arrow keys to jump between parent menus and submenus. Hitting the *Enter*
key executes the selected item. The *Escape* key closes the menu or stops menu
traversal.
Menus can be forced to remain open on the workspace by left-clicking the
titlebar. This creates a *close* button on the titlebar.
Root window menu
----------------
.. figure:: images/menu_applications.png
:alt: Root window menu (applications menu)
:figclass: borderless
Root window menu (applications menu)
The root window menu or applications menu is opened by right-clicking on an
empty area of the workspace or by hitting the pre-defined keyboard shortcut
(default is F12). This menu launches applications, allows for the customization
of the workspace (backgrounds, themes...), and the management of other
workspace characteristics using standard X utilities (xprop, xfontsel,
xcmap...).
The menu content is totally configurable, either using WPrefs.app or by editing
the plain text menu file. Instructions on how to configure one or the other can
be found in the WindowMaker directory of the distribution. To use WPrefs.app,
menus must be in property list format (plmenu). A script is available to
convert plain text menus to property list menus and it's called wm-oldmenu2new.
Window list menu
----------------
.. figure:: images/menu_window_list.png
:alt: Window list menu
:figclass: borderless
Window list menu
Middle-clicking an empty area of the workspace opens the window list menu. With
a two-button mouse, clicking both buttons at once usually gives the same
result. F11 is the default keyboard shortcut to open the window list menu.
This menu lists all windows - whether active or inactive - in every workspace.
The workspace containing each window is indicated at the right of the window
name. The current focused window is marked by a diamond sign to the left of the
window's name. Clicking any window in the list focuses and raises the
corresponding window and moves you to the workspace where it's located.
Workspaces menu
---------------
.. figure:: images/menu_workspaces.png
:alt: Workspaces menu
:figclass: borderless
Workspaces menu
The workspaces menu is part of the root menu (applications menu). This item
has three options: *new*, *destroy last* and *last used*.
The first option creates a new workspace and automatically switches you to it.
The second option destroys the last workspace as soon as there are no windows
opened in it.
The third option switches to last visited workspace.
Each workspace has a corresponding item in this menu. The active workspace is
indicated by a diamond to the left of the workspace name or number.
Clicking a workspace entry switches from the current workspace to the selected
workspace.
To change the name of a workspace, first "stick" the menu by left-clicking the
menu titlebar. Then *Ctrl + click* the menu item to make it editable and type
in the new name. Hitting *Return* saves the new name, hitting *Escape* cancels
the operation.
Key bindings allow movement from one workspace to another. Usually *Meta +
(number)*. The *Meta* key is normally the "*Alt*" key, while *(number)*
represents a number key that corresponds to the workspace number. For instance
1 can be the default workspace (workspace 1), 2 the second workspace and so on.
Thus, *Meta + 2* switches to workspace 2.
These key bindings can be set (or changed) from the keyboard shortcut dialog in
WPrefs.app.
Application icon menu
---------------------
.. figure:: images/menu_application_icon.png
:alt: Icon application menu
:figclass: borderless
Icon application menu
Clicking an icon in the dock with the right mouse button brings a menu for
modifying that icon's application. There are several options available in the
application icon menu for docked applications. Docked, but not running
applications will not have all options available - they will appear "greyed
out" in the menu.
#. First option is a global Dock submenu, which have three items:
#. *Normal* will not change dock behaviour - it can be covered by windows,
while clicking on any docked items will bring it up.
#. *Auto raise & lower* is similar for the first options, although you don't
have to click on dock - it's enough to hover mouse pointer on visible
part of dock or it's items.
#. *Keep on top* means that the dock will always be on "top" of opened
windows.
#. *Add a drawer* will add special dockapp which can be used for aggregating
applications. See `Dock <dock.html>`_ for more details about drawers.
#. "Launch" opens the application without double-clicking the icon.
#. "Bring here" unhides the application in the current workspace.
#. "Hide" hides the application or unhides it if already hidden. Unhiding opens
the application in the workspace where it is located. (This option may not
work if the application has it's own hiding menu option.)
#. "Settings" allows the modification of application path and arguments, the
command line, and the icon used.
#. "Kill" closes the application immediately and should only be used if
absolutely necessary.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Menus</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

121
docs/guidedtour/misc.html Normal file
View File

@@ -0,0 +1,121 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Miscellaneous</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="miscellaneous">
<h1 class="title">Miscellaneous</h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#localization" id="id1">Localization</a></p></li>
<li><p><a class="reference internal" href="#fonts" id="id2">Fonts</a></p></li>
<li><p><a class="reference internal" href="#utilities" id="id3">Utilities</a></p></li>
</ul>
</div>
<div class="section" id="localization">
<h1>Localization</h1>
<p>As soon as Window Maker is compiled with some options and gettext installed, it
is fully localizable. Check the INSTALL file.</p>
<p>However, localization of menus can be used without the LANG environment
variable set. Using pl menu allows to get menus in any available language
without setting this variable.</p>
<p>Why do such a "thing" instead of setting the localization the "right" way?</p>
<p>For some reasons users may want to keep the system default language instead of
defining a new localization. One of the main reason is that most software
doesn't exist in all languages.</p>
</div>
<div class="section" id="fonts">
<h1>Fonts</h1>
<p>It's possible to change the fonts in Window Maker, editing the WindowMaker file
or the WMGLOBAL file in <span class="docutils literal">~/GNUstep/Defaults</span>.</p>
<p>Once again the INSTALL file gives instructions on how to do it.</p>
<p>The specific file to edit varies according to the fonts to be changed.</p>
<p>The script <em>wsetfont</em> is provided to do the job.</p>
</div>
<div class="section" id="utilities">
<h1>Utilities</h1>
<p>Window Maker provides the user with some useful utilities.</p>
<p>There is a README file concerning these scripts in the util directory.</p>
<p>Almost each script has it's own man page recommended reading.</p>
<p>These utilities mainly concern the GUI: icons, styles, fonts, menus,
backgrounds.</p>
<p>A few of them deserve special interest as many users don't seem to know about
them.</p>
<p>The <em>wdwrite</em> script, for instance, writes data into the configuration files.</p>
<p>The <em>setstyle</em> (or <em>getstyle</em>) scripts are used to manage themes.</p>
<p><em>Wxcopy</em> and <em>wxpaste</em> allows copying and pasting using the X cutbuffer.</p>
<p>The first one makes part of the default applications menu, in the selection
item.</p>
<p>For KDE users, wkdemenu.pl is worth using.</p>
<p>From version 0.63.0 on, a new utility is available : <em>wmagnify</em>. It allows
magnification of the area under the mouse pointer.</p>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Miscellaneous</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

133
docs/guidedtour/misc.rst Normal file
View File

@@ -0,0 +1,133 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Miscellaneous</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Miscellaneous
=============
.. contents::
:backlinks: none
Localization
------------
As soon as Window Maker is compiled with some options and gettext installed, it
is fully localizable. Check the INSTALL file.
However, localization of menus can be used without the LANG environment
variable set. Using pl menu allows to get menus in any available language
without setting this variable.
Why do such a "thing" instead of setting the localization the "right" way?
For some reasons users may want to keep the system default language instead of
defining a new localization. One of the main reason is that most software
doesn't exist in all languages.
Fonts
-----
It's possible to change the fonts in Window Maker, editing the WindowMaker file
or the WMGLOBAL file in ``~/GNUstep/Defaults``.
Once again the INSTALL file gives instructions on how to do it.
The specific file to edit varies according to the fonts to be changed.
The script *wsetfont* is provided to do the job.
Utilities
---------
Window Maker provides the user with some useful utilities.
There is a README file concerning these scripts in the util directory.
Almost each script has it's own man page recommended reading.
These utilities mainly concern the GUI: icons, styles, fonts, menus,
backgrounds.
A few of them deserve special interest as many users don't seem to know about
them.
The *wdwrite* script, for instance, writes data into the configuration files.
The *setstyle* (or *getstyle*) scripts are used to manage themes.
*Wxcopy* and *wxpaste* allows copying and pasting using the X cutbuffer.
The first one makes part of the default applications menu, in the selection
item.
For KDE users, wkdemenu.pl is worth using.
From version 0.63.0 on, a new utility is available : *wmagnify*. It allows
magnification of the area under the mouse pointer.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Miscellaneous</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

524
docs/guidedtour/prefs.html Normal file
View File

@@ -0,0 +1,524 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Prefs</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="preferences">
<h1 class="title">Preferences</h1>
<div class="borderless figure">
<img alt="images/wprefs.jpg" src="images/wprefs.jpg" style="width: 64px; height: 64px;">
</div>
<div class="section" id="wprefs-app">
<h1>WPrefs.app</h1>
<p>WPrefs.app is the heart of the configuration process in Window Maker.</p>
<p>Upon installing Window Maker and running it for the first time, the WPrefs
application is available under dock icon by default:</p>
<div class="borderless figure">
<img alt="GNUstep Logo" src="images/dock_tile.png">
</div>
<p>although, depending on your distibution, location, menu entry or icon may be
different. Ususally Linux distributions position WPrefs as the second or third
icon in the Dock column by default, just above or below the terminal icon.</p>
<p>Double-clicking on this icon opens the WPrefs.app window. Across the top of
the window there is a row of icons, each one corresponding to a group of
settings options. There is a checkbox for balloon help on the bottom left of
the WPrefs.app window. Most of the following is taken directly from the content
of the ballon help dialogs.</p>
<div class="borderless figure">
<img alt="WPrefs.app after launching" src="images/prefs0.png">
<p class="caption">WPrefs.app after launching</p>
</div>
<div class="contents local topic" id="available-preference-settings">
<p class="topic-title first">Available preference settings</p>
<ul class="simple">
<li><p><a class="reference internal" href="#window-focus" id="id1">Window focus</a></p></li>
<li><p><a class="reference internal" href="#window-handling" id="id2">Window handling</a></p></li>
<li><p><a class="reference internal" href="#menu" id="id3">Menu</a></p></li>
<li><p><a class="reference internal" href="#icon" id="id4">Icon</a></p></li>
<li><p><a class="reference internal" href="#ergonomy" id="id5">Ergonomy</a></p></li>
<li><p><a class="reference internal" href="#search-path" id="id6">Search Path</a></p></li>
<li><p><a class="reference internal" href="#dock" id="id7">Dock</a></p></li>
<li><p><a class="reference internal" href="#workspace" id="id8">Workspace</a></p></li>
<li><p><a class="reference internal" href="#other" id="id9">Other</a></p></li>
<li><p><a class="reference internal" href="#applications-menu" id="id10">Applications menu</a></p></li>
<li><p><a class="reference internal" href="#keyboard-shortcut" id="id11">Keyboard shortcut</a></p></li>
<li><p><a class="reference internal" href="#mouse" id="id12">Mouse</a></p></li>
<li><p><a class="reference internal" href="#appearance" id="id13">Appearance</a></p></li>
<li><p><a class="reference internal" href="#font-configuration" id="id14">Font configuration</a></p></li>
<li><p><a class="reference internal" href="#expert-user" id="id15">Expert user</a></p></li>
<li><p><a class="reference internal" href="#editing-the-configuration-file" id="id16">Editing the configuration file</a></p></li>
</ul>
</div>
<div class="section" id="window-focus">
<h2>Window focus</h2>
<div class="borderless figure">
<img alt="WPrefs.app window focus controls" src="images/prefs1.png">
<p class="caption">WPrefs.app window focus controls</p>
</div>
<p>The first icon from the left-hand side controls the way windows get
their focus (how they are activated).</p>
<ul>
<li>
<p><em>Input focus mode</em> (two choices are available):</p>
<ul class="simple">
<li><p><strong>Manual</strong> - click on the window to set keyboard input focus.</p></li>
<li><p><strong>Auto</strong> - set keyboard input focus to the window under the mouse pointer.</p></li>
</ul>
</li>
<li>
<p><em>Install colormap in the window</em></p>
<p>Select either (a) install the colormap in the window that has the input focus
or (b) that is under the mouse pointer.</p>
</li>
<li>
<p><em>Automatic window raise delay</em></p>
<p>Setting the delay (in msec) for automatic window raising</p>
</li>
<li>
<p><em>Checkboxes</em></p>
<p>The topmost check box prevents applications from receiving the focusing
mouse-click (I don't know why you would use this, but some people obviously
find it useful). The middle checkbox allows you to choose whether
newly-opened application windows automatically receive the focus, or must be
clicked to gain focus. The bottom allows you to bring window up while using
keyboard.</p>
</li>
</ul>
</div>
<div class="section" id="window-handling">
<h2>Window handling</h2>
<div class="borderless figure">
<img alt="WPrefs.app window handling preferences" src="images/prefs2.png">
<p class="caption">WPrefs.app window handling preferences</p>
</div>
<p>Clicking the second icon allows you to select the window handling options.
Clicking on this icon opens a panel allowing you to define the default
placement and properties of windows in the workspace.</p>
<ul>
<li>
<p><em>Window placement</em></p>
<p>You can use the sliders around the screen representation to modify the
original placement. The gadget tells Window Maker how to order windows on the
screen: <em>Random</em>, <em>Manual</em>, <em>Cascade</em> or <em>Smart</em>. <em>Automatic</em> is the default.</p>
</li>
<li>
<p><em>Dragging a maximized window</em></p>
<p>Set the behaviour of maximized window when click on titlebar and drag with
the mouse. Possible actions can be set for a window to:</p>
<ul class="simple">
<li><p><em>changes its position</em></p></li>
<li><p><em>restores its unmaximized geometry</em></p></li>
<li><p><em>considers the window now unmaximized</em></p></li>
<li><p><em>does not move the window</em></p></li>
</ul>
</li>
<li>
<p><em>Edge resistance</em></p>
<p>To set the edge resistance and whether it resists or attracts windows.
According to the selection, windows resist or attract when moved against
other windows or the edges of the screen. The slider defines the threshold.
Some applications' title bars may disappear at the top of the screen, with
the window being too high for the screen area. Setting the edge resistance to
"0" may solve this problem</p>
</li>
<li>
<p><em>Mod+Wheel</em></p>
<p>You can define, how many pixels window should increment/decrement by using
modifer keys + mouse wheel. By default, CTRL+wheel will change window size
horizontally, while SUPER+wheel vertically.</p>
</li>
</ul>
<!-- 1. *Open dialogs in the same workspace as their owners*
Obviously, whether to force dialog boxes "spawned" by an application to open
in same workspace as their owners. -->
<ul>
<li>
<p><em>When maximizing</em></p>
<p>This option allows the window to cover (or not) icons or the dock when
maximizing.</p>
</li>
<li>
<p><em>Opaque move/resize</em></p>
<p>Clicking on <em>opaque move</em> causes windows to be moved with their contents
visible. If not checked, only the frame is displayed during the move. <em>Opaque
resize</em> makes window contents visible during resizing, otherwise only the
frame is displayed.</p>
</li>
</ul>
</div>
<div class="section" id="menu">
<h2>Menu</h2>
<div class="borderless figure">
<img alt="WPrefs.app menu preferences" src="images/prefs3.png">
<p class="caption">WPrefs.app menu preferences</p>
</div>
<p>This panel allows you to set menu scrolling speed and submenu alignment with
the parent menu. In addition, two checkboxes are provided:</p>
<ul class="simple">
<li><p>The topmost box forces submenus to open inside the screen instead of
scrolling when they would otherwise be off-screen.</p></li>
<li><p>The middle box allows submenus to open off-screen, but causes off-screen
menus to scroll when the mouse pointer is moved over them. This setting is
also of value if you "tear off" a menu and leave it positioned on the
desktop. In that case, you might wish to "park" the menu off-screen (with
only the titlebar showing, for example) and have it reappear when you mouse
over it. This is convenient in some workflows, as when you have multiple
applications open and you are using the window list menu to switch between
applications.</p></li>
<li><p>The bottom box allows you to assign Vim-like keybindings for the selection
of menu items.</p></li>
</ul>
</div>
<div class="section" id="icon">
<h2>Icon</h2>
<div class="borderless figure">
<img alt="WPrefs.app icon preferences" src="images/prefs4.png">
<p class="caption">WPrefs.app icon preferences</p>
</div>
<p>Set icon or miniwindow handling options.</p>
<ul>
<li>
<p><em>Icon positioning</em></p>
<p>This area defines the initial placement of miniwindows or icons will be
displayed: <em>bottom, top, right, left</em>...</p>
</li>
<li>
<p><em>Icon size</em></p>
<p>Selects the size of the icons shown when a window is miniaturized and for
application icons. Dockapp developers usually assume that tiles will be 64x64
pixels, so it's probably a good idea to leave it at that size, unless you
know you won't be using dockapps.</p>
</li>
<li>
<p><em>Mini-Previews for Icons</em></p>
<p>Allows to display content of the window, while hovering the mouse on
minimised application icon. The slider allows to set the size of the preview.</p>
</li>
<li>
<p><em>Iconification animation</em></p>
<p>When an application's window is miniaturized, <em>miniaturization animation
style</em> offers four animation choices.</p>
<ul class="simple">
<li><p>Shrinking/Zooming,</p></li>
<li><p>Spinning/Twisting,</p></li>
<li><p>3D Flipping, or</p></li>
<li><p>None</p></li>
</ul>
</li>
<li>
<p><em>Checkboxes</em></p>
<p>The topmost box enables/disables auto-arrangement of icons. The middle box
places miniwindows for opened applications on all existing workspaces
(<em>omnipresent</em>). The bottom box, allows to use single click for minimized or
docked icons isntead of double clicking.</p>
</li>
</ul>
</div>
<div class="section" id="ergonomy">
<h2>Ergonomy</h2>
<div class="borderless figure">
<img alt="WPrefs.app ergonomic settings" src="images/prefs5.png">
<p class="caption">WPrefs.app ergonomic settings</p>
</div>
<p>Various types of information are defined in this panel.</p>
<ul>
<li>
<p><em>Size display</em></p>
<p>Window Maker provides a box that informs you about the size of a window
during resizing. You may choose to have this display (a) in the center of the
screen, (b) the center of the screen, (c) the center of the resized
window, (d) the side and bottom of the window as a technical drawing-like
size display or (e) not at all.</p>
</li>
<li>
<p><em>Position display</em></p>
<p>Same information as above but regarding the screen placement of a
window while moving (no technical drawing-like option).</p>
</li>
<li>
<p><em>Appicon bouncing</em></p>
<p>You can set the behaviour of AppIcons bounce here.</p>
</li>
<li>
<p><em>Show balloon text for</em></p>
<p>Selecting checkboxes displays balloon text for: incomplete window titles,
miniwindow titles, application and dock icons, or internal help. This may be
useful for new users but many people find having help balloons pop out all
over the desktop gets annoying quickly. I use the <em>incomplete window title</em>
and the <em>miniwindow title</em> options and none of the others.</p>
</li>
<li>
<p><em>Workspace border</em></p>
<p>You can set a small border for the workspace. This allows you to easily
access the clip (for instance) when windows are maximized.</p>
</li>
</ul>
<!-- - *Checkbox*
The top check box, if selected, raises a window when switching focus with the
keyboard. The bottom box enables a keyboard language selection button on
window titlebars (must have multiple keyboard maps/locales defined - this is
handy if you are working in multiple languages in applications such as word
processors, for example). -->
</div>
<div class="section" id="search-path">
<h2>Search Path</h2>
<div class="borderless figure">
<img alt="WPrefs.app icon and pixmap search path settings" src="images/prefs6.png">
<p class="caption">WPrefs.app icon and pixmap search path settings</p>
</div>
<p>This panel is used to add or delete directory paths to search for icons and
pixmaps. These paths are used in the <em>settings</em> dialogs for dockapps and docked
application icons, so having a good, complete set of defined paths is
important. This may require some manual intervention, especially upon initial
setup, since some default paths will not be present on your system, while
others not predefined will be present. Use the <em>add</em> and <em>remove</em> dialogs to
configure according to what is actually available.</p>
</div>
<div class="section" id="dock">
<h2>Dock</h2>
<div class="borderless figure">
<img alt="WPrefs.app dock preference settings" src="images/prefs7.png">
<p class="caption">WPrefs.app dock preference settings</p>
</div>
<p>In this panel you can fine-tune Dock/Clip/Drawer behaviour.</p>
<ul>
<li><p><em>Clip autocollapsing delays</em> and <em>Clip autoraising delays</em> lets you choose
delays for expansion, collapsing, raising and lowering the Clip</p></li>
<li>
<p><em>Dock/Clip/Drawer</em></p>
<p>First icon enables/disables thr Dock, vertical bar for your appicons and
applications. Second allows to enables/disables Clip, the tile with the
paperclip icon. Last one enables/disables Drawer - a special dockapp for
keeping the applications icons horizontally.</p>
</li>
</ul>
</div>
<div class="section" id="workspace">
<h2>Workspace</h2>
<div class="borderless figure">
<img alt="WPrefs.app workspace preference settings" src="images/prefs8.png">
<p class="caption">WPrefs.app workspace preference settings</p>
</div>
<p>This panel defines navigation features within the workspace.</p>
<ul>
<li>
<p><em>Workspace navigation</em></p>
<p>Selecting the first checkbox allows switching to the first workspace when
switching past the last workspace and vice-versa. Selecting the second
checkbox allows windows to be dragged from one workspace to another.
Selecting the third checkbox cause a new workspace to be created when windows
are dragged off the last existing workspace. A selection menu allows you to
define where the workspace name is displayed each time you move from one
workspace to another (or not to display the workspace name at all).</p>
</li>
</ul>
</div>
<div class="section" id="other">
<h2>Other</h2>
<div class="borderless figure">
<img alt="WPrefs.app other workspace configuration settings" src="images/prefs9.png">
<p class="caption">WPrefs.app other workspace configuration settings</p>
</div>
<p>This panel sets icon slide speed, shade animation speed, smooth scaling and
titlebar control (button) style. Animations and sound are also defined here.</p>
<ul>
<li>
<p><em>Icon slide speed</em></p>
<p>Selecting the left icon gives the slowest result, selecting the right one
gives the fastest.</p>
</li>
<li>
<p><em>Shade animation speed</em></p>
<p>Same as icon slide</p>
</li>
<li>
<p><em>Titlebar style</em></p>
<p>To choose a more or less "NeXTish" titlebar. (The top version is "newer,"
while the bottom left is ca. 1990 and the bottom right is ca. 1988.)</p>
</li>
<li>
<p><em>Animations</em></p>
<p>Selecting the animations icon enables animations for window miniaturization,
shading and so on. Selecting the superfluous icon enables "ghosting" of dock
(when moved - especially when moved from one side of the screen to the other)
and explosion animation for icons you remove from the dock.</p>
</li>
<li>
<p><em>Smooth scaling</em></p>
<p>If selected, neutralizes pixelization effect on background images. The
side-effect is to slow down background image loading.</p>
</li>
<li>
<p><em>Dithering colormap for 8bpp</em></p>
<p>For 8-bit displays (anyone still have one of these?) this enables dithering
and changes the number of colors to reserve either for applications or for
Window Maker. The Default setting almost always gives the best result.</p>
</li>
</ul>
</div>
<div class="section" id="applications-menu">
<h2>Applications menu</h2>
<div class="borderless figure">
<img alt="WPrefs.app application menu configuration" src="images/prefs10.png">
<p class="caption">WPrefs.app application menu configuration</p>
</div>
<p>In this panel the applications menu and the commands to launch each application
can be defined. This panel has been changed in version 0.63.and later. It now
displays the actual menu thus allowing direct editing. This can be done only if
the menu is in property list format. Menus in plain text format can't be
edited in WPrefs. Check the README file in the Window Maker directory on how to
use one or the other.</p>
</div>
<div class="section" id="keyboard-shortcut">
<h2>Keyboard shortcut</h2>
<div class="borderless figure">
<img alt="WPrefs.app keyboard shortcut settings" src="images/prefs11.png">
<p class="caption">WPrefs.app keyboard shortcut settings</p>
</div>
<p>Many actions in Window Maker have predefined keyboard shortcuts. These actions
mainly concern windows and workspaces. Modifying, adding or removing shortcuts
can be done in this panel. Defining a shortcut can be done interactively,
capturing the key combination.</p>
</div>
<div class="section" id="mouse">
<h2>Mouse</h2>
<div class="borderless figure">
<img alt="WPrefs.app mouse configuration" src="images/prefs12.png">
<p class="caption">WPrefs.app mouse configuration</p>
</div>
<p>The mouse grab modifier represents the keyboard shortcut to use for actions
like dragging windows with the mouse or clicking inside the window. Mod1 (Alt)
is the default.</p>
<p>This panel sets the mouse speed and double-click delay. Mouse button bindings
can be defined and can be disabled or enabled.</p>
<p>The default setting binds the right mouse button to the applications menu,
middle button to the window list menu and left button to window selection
(focus). Of course, with a two button mouse, the middle button binding will not
work. However, on some OSes pressing both buttons at once gives the same result
as the one obtained with middle button.</p>
<p>Starting from version 0.65 on, the mouse wheel can be used to switch
workspaces. This is not default behavior and must be enabled here.</p>
<p>If mouse have more than 3 buttons and/or tilt, they can be bound to some
actions.</p>
</div>
<div class="section" id="appearance">
<h2>Appearance</h2>
<div class="borderless figure">
<img alt="WPrefs.app appearance settings" src="images/prefs13.png">
<p class="caption">WPrefs.app appearance settings</p>
</div>
<p>In this panel, everything related to the appearance of the GUI (except the
background color or image) can be configured. Windows, menus and icons can have
their own background "texture," meaning color gradients of various types can be
configured here. Texture, color, menu style, and title alignment can be fully
customized.</p>
</div>
<div class="section" id="font-configuration">
<h2>Font configuration</h2>
<div class="borderless figure">
<img alt="Wprefs.app font configuration options" src="images/prefs14.png">
<p class="caption">Wprefs.app font configuration options</p>
</div>
<p>This panel allows you to configure fonts for the window and menu titlebars, for
the menu body text, and for the icon and clip text. In addition, a font may be
defined for desktop messages.</p>
</div>
<div class="section" id="expert-user">
<h2>Expert user</h2>
<div class="borderless figure">
<img alt="WPrefs.app expert user settings" src="images/prefs15.png">
<p class="caption">WPrefs.app expert user settings</p>
</div>
<p>Using this panel implies some knowledge. Many options are available. Among
these are:</p>
<ul class="simple">
<li><p>Disabling miniwindows (useful when using with KDE and GNOME)</p></li>
<li><p>Using (or not) xset</p></li>
<li><p>Saving session on exit (highly recommended!)</p></li>
<li><p>Using SaveUnder in different objects</p></li>
<li><p>Using Win style cycling (added from version 0.63.0)</p></li>
<li><p>Disabling confirmation panel for the kill command</p></li>
<li><p>Disabling cycling colors highlighting of icons</p></li>
<li><p>Multi head related options</p></li>
<li><p>Screen edge snapping</p></li>
</ul>
</div>
<div class="section" id="editing-the-configuration-file">
<h2>Editing the configuration file</h2>
<p>If needed, the defaults configuration file found in
$(HOME)/GNUstep/Defaults/WindowMaker can be edited by hand. This file is a
database with a property list syntax. When selecting an option in WPrefs.app,
it's written down into this file. When modifying this defaults file, it's very
important to follow the syntax.</p>
</div>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Prefs</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

548
docs/guidedtour/prefs.rst Normal file
View File

@@ -0,0 +1,548 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Prefs</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
===========
Preferences
===========
.. figure:: images/wprefs.jpg
:figclass: borderless
:height: 64
:width: 64
WPrefs.app
----------
WPrefs.app is the heart of the configuration process in Window Maker.
Upon installing Window Maker and running it for the first time, the WPrefs
application is available under dock icon by default:
.. figure:: images/dock_tile.png
:figclass: borderless
:alt: GNUstep Logo
although, depending on your distibution, location, menu entry or icon may be
different. Ususally Linux distributions position WPrefs as the second or third
icon in the Dock column by default, just above or below the terminal icon.
Double-clicking on this icon opens the WPrefs.app window. Across the top of
the window there is a row of icons, each one corresponding to a group of
settings options. There is a checkbox for balloon help on the bottom left of
the WPrefs.app window. Most of the following is taken directly from the content
of the ballon help dialogs.
.. figure:: images/prefs0.png
:alt: WPrefs.app after launching
:figclass: borderless
WPrefs.app after launching
.. contents:: Available preference settings
:backlinks: none
:local:
Window focus
~~~~~~~~~~~~
.. figure:: images/prefs1.png
:alt: WPrefs.app window focus controls
:figclass: borderless
WPrefs.app window focus controls
The first icon from the left-hand side controls the way windows get
their focus (how they are activated).
- *Input focus mode* (two choices are available):
- **Manual** - click on the window to set keyboard input focus.
- **Auto** - set keyboard input focus to the window under the mouse pointer.
- *Install colormap in the window*
Select either (a) install the colormap in the window that has the input focus
or (b) that is under the mouse pointer.
- *Automatic window raise delay*
Setting the delay (in msec) for automatic window raising
- *Checkboxes*
The topmost check box prevents applications from receiving the focusing
mouse-click (I don't know why you would use this, but some people obviously
find it useful). The middle checkbox allows you to choose whether
newly-opened application windows automatically receive the focus, or must be
clicked to gain focus. The bottom allows you to bring window up while using
keyboard.
Window handling
~~~~~~~~~~~~~~~
.. figure:: images/prefs2.png
:alt: WPrefs.app window handling preferences
:figclass: borderless
WPrefs.app window handling preferences
Clicking the second icon allows you to select the window handling options.
Clicking on this icon opens a panel allowing you to define the default
placement and properties of windows in the workspace.
- *Window placement*
You can use the sliders around the screen representation to modify the
original placement. The gadget tells Window Maker how to order windows on the
screen: *Random*, *Manual*, *Cascade* or *Smart*. *Automatic* is the default.
- *Dragging a maximized window*
Set the behaviour of maximized window when click on titlebar and drag with
the mouse. Possible actions can be set for a window to:
- *changes its position*
- *restores its unmaximized geometry*
- *considers the window now unmaximized*
- *does not move the window*
- *Edge resistance*
To set the edge resistance and whether it resists or attracts windows.
According to the selection, windows resist or attract when moved against
other windows or the edges of the screen. The slider defines the threshold.
Some applications' title bars may disappear at the top of the screen, with
the window being too high for the screen area. Setting the edge resistance to
"0" may solve this problem
- *Mod+Wheel*
You can define, how many pixels window should increment/decrement by using
modifer keys + mouse wheel. By default, CTRL+wheel will change window size
horizontally, while SUPER+wheel vertically.
..
1. *Open dialogs in the same workspace as their owners*
Obviously, whether to force dialog boxes "spawned" by an application to open
in same workspace as their owners.
- *When maximizing*
This option allows the window to cover (or not) icons or the dock when
maximizing.
- *Opaque move/resize*
Clicking on *opaque move* causes windows to be moved with their contents
visible. If not checked, only the frame is displayed during the move. *Opaque
resize* makes window contents visible during resizing, otherwise only the
frame is displayed.
Menu
~~~~
.. figure:: images/prefs3.png
:figclass: borderless
:alt: WPrefs.app menu preferences
WPrefs.app menu preferences
This panel allows you to set menu scrolling speed and submenu alignment with
the parent menu. In addition, two checkboxes are provided:
- The topmost box forces submenus to open inside the screen instead of
scrolling when they would otherwise be off-screen.
- The middle box allows submenus to open off-screen, but causes off-screen
menus to scroll when the mouse pointer is moved over them. This setting is
also of value if you "tear off" a menu and leave it positioned on the
desktop. In that case, you might wish to "park" the menu off-screen (with
only the titlebar showing, for example) and have it reappear when you mouse
over it. This is convenient in some workflows, as when you have multiple
applications open and you are using the window list menu to switch between
applications.
- The bottom box allows you to assign Vim-like keybindings for the selection
of menu items.
Icon
~~~~
.. figure:: images/prefs4.png
:figclass: borderless
:alt: WPrefs.app icon preferences
WPrefs.app icon preferences
Set icon or miniwindow handling options.
- *Icon positioning*
This area defines the initial placement of miniwindows or icons will be
displayed: *bottom, top, right, left*...
- *Icon size*
Selects the size of the icons shown when a window is miniaturized and for
application icons. Dockapp developers usually assume that tiles will be 64x64
pixels, so it's probably a good idea to leave it at that size, unless you
know you won't be using dockapps.
- *Mini-Previews for Icons*
Allows to display content of the window, while hovering the mouse on
minimised application icon. The slider allows to set the size of the preview.
- *Iconification animation*
When an application's window is miniaturized, *miniaturization animation
style* offers four animation choices.
- Shrinking/Zooming,
- Spinning/Twisting,
- 3D Flipping, or
- None
- *Checkboxes*
The topmost box enables/disables auto-arrangement of icons. The middle box
places miniwindows for opened applications on all existing workspaces
(*omnipresent*). The bottom box, allows to use single click for minimized or
docked icons isntead of double clicking.
Ergonomy
~~~~~~~~
.. figure:: images/prefs5.png
:figclass: borderless
:alt: WPrefs.app ergonomic settings
WPrefs.app ergonomic settings
Various types of information are defined in this panel.
- *Size display*
Window Maker provides a box that informs you about the size of a window
during resizing. You may choose to have this display (a) in the center of the
screen, (b) the center of the screen, (c) the center of the resized
window, (d) the side and bottom of the window as a technical drawing-like
size display or (e) not at all.
- *Position display*
Same information as above but regarding the screen placement of a
window while moving (no technical drawing-like option).
- *Appicon bouncing*
You can set the behaviour of AppIcons bounce here.
- *Show balloon text for*
Selecting checkboxes displays balloon text for: incomplete window titles,
miniwindow titles, application and dock icons, or internal help. This may be
useful for new users but many people find having help balloons pop out all
over the desktop gets annoying quickly. I use the *incomplete window title*
and the *miniwindow title* options and none of the others.
- *Workspace border*
You can set a small border for the workspace. This allows you to easily
access the clip (for instance) when windows are maximized.
..
- *Checkbox*
The top check box, if selected, raises a window when switching focus with the
keyboard. The bottom box enables a keyboard language selection button on
window titlebars (must have multiple keyboard maps/locales defined - this is
handy if you are working in multiple languages in applications such as word
processors, for example).
Search Path
~~~~~~~~~~~
.. figure:: images/prefs6.png
:figclass: borderless
:alt: WPrefs.app icon and pixmap search path settings
WPrefs.app icon and pixmap search path settings
This panel is used to add or delete directory paths to search for icons and
pixmaps. These paths are used in the *settings* dialogs for dockapps and docked
application icons, so having a good, complete set of defined paths is
important. This may require some manual intervention, especially upon initial
setup, since some default paths will not be present on your system, while
others not predefined will be present. Use the *add* and *remove* dialogs to
configure according to what is actually available.
Dock
~~~~
.. figure:: images/prefs7.png
:figclass: borderless
:alt: WPrefs.app dock preference settings
WPrefs.app dock preference settings
In this panel you can fine-tune Dock/Clip/Drawer behaviour.
- *Clip autocollapsing delays* and *Clip autoraising delays* lets you choose
delays for expansion, collapsing, raising and lowering the Clip
- *Dock/Clip/Drawer*
First icon enables/disables thr Dock, vertical bar for your appicons and
applications. Second allows to enables/disables Clip, the tile with the
paperclip icon. Last one enables/disables Drawer - a special dockapp for
keeping the applications icons horizontally.
Workspace
~~~~~~~~~
.. figure:: images/prefs8.png
:figclass: borderless
:alt: WPrefs.app workspace preference settings
WPrefs.app workspace preference settings
This panel defines navigation features within the workspace.
- *Workspace navigation*
Selecting the first checkbox allows switching to the first workspace when
switching past the last workspace and vice-versa. Selecting the second
checkbox allows windows to be dragged from one workspace to another.
Selecting the third checkbox cause a new workspace to be created when windows
are dragged off the last existing workspace. A selection menu allows you to
define where the workspace name is displayed each time you move from one
workspace to another (or not to display the workspace name at all).
Other
~~~~~
.. figure:: images/prefs9.png
:figclass: borderless
:alt: WPrefs.app other workspace configuration settings
WPrefs.app other workspace configuration settings
This panel sets icon slide speed, shade animation speed, smooth scaling and
titlebar control (button) style. Animations and sound are also defined here.
- *Icon slide speed*
Selecting the left icon gives the slowest result, selecting the right one
gives the fastest.
- *Shade animation speed*
Same as icon slide
- *Titlebar style*
To choose a more or less "NeXTish" titlebar. (The top version is "newer,"
while the bottom left is ca. 1990 and the bottom right is ca. 1988.)
- *Animations*
Selecting the animations icon enables animations for window miniaturization,
shading and so on. Selecting the superfluous icon enables "ghosting" of dock
(when moved - especially when moved from one side of the screen to the other)
and explosion animation for icons you remove from the dock.
- *Smooth scaling*
If selected, neutralizes pixelization effect on background images. The
side-effect is to slow down background image loading.
- *Dithering colormap for 8bpp*
For 8-bit displays (anyone still have one of these?) this enables dithering
and changes the number of colors to reserve either for applications or for
Window Maker. The Default setting almost always gives the best result.
Applications menu
~~~~~~~~~~~~~~~~~
.. figure:: images/prefs10.png
:figclass: borderless
:alt: WPrefs.app application menu configuration
WPrefs.app application menu configuration
In this panel the applications menu and the commands to launch each application
can be defined. This panel has been changed in version 0.63.and later. It now
displays the actual menu thus allowing direct editing. This can be done only if
the menu is in property list format. Menus in plain text format can't be
edited in WPrefs. Check the README file in the Window Maker directory on how to
use one or the other.
Keyboard shortcut
~~~~~~~~~~~~~~~~~
.. figure:: images/prefs11.png
:figclass: borderless
:alt: WPrefs.app keyboard shortcut settings
WPrefs.app keyboard shortcut settings
Many actions in Window Maker have predefined keyboard shortcuts. These actions
mainly concern windows and workspaces. Modifying, adding or removing shortcuts
can be done in this panel. Defining a shortcut can be done interactively,
capturing the key combination.
Mouse
~~~~~
.. figure:: images/prefs12.png
:figclass: borderless
:alt: WPrefs.app mouse configuration
WPrefs.app mouse configuration
The mouse grab modifier represents the keyboard shortcut to use for actions
like dragging windows with the mouse or clicking inside the window. Mod1 (Alt)
is the default.
This panel sets the mouse speed and double-click delay. Mouse button bindings
can be defined and can be disabled or enabled.
The default setting binds the right mouse button to the applications menu,
middle button to the window list menu and left button to window selection
(focus). Of course, with a two button mouse, the middle button binding will not
work. However, on some OSes pressing both buttons at once gives the same result
as the one obtained with middle button.
Starting from version 0.65 on, the mouse wheel can be used to switch
workspaces. This is not default behavior and must be enabled here.
If mouse have more than 3 buttons and/or tilt, they can be bound to some
actions.
Appearance
~~~~~~~~~~
.. figure:: images/prefs13.png
:figclass: borderless
:alt: WPrefs.app appearance settings
WPrefs.app appearance settings
In this panel, everything related to the appearance of the GUI (except the
background color or image) can be configured. Windows, menus and icons can have
their own background "texture," meaning color gradients of various types can be
configured here. Texture, color, menu style, and title alignment can be fully
customized.
Font configuration
~~~~~~~~~~~~~~~~~~
.. figure:: images/prefs14.png
:figclass: borderless
:alt: Wprefs.app font configuration options
Wprefs.app font configuration options
This panel allows you to configure fonts for the window and menu titlebars, for
the menu body text, and for the icon and clip text. In addition, a font may be
defined for desktop messages.
Expert user
~~~~~~~~~~~
.. figure:: images/prefs15.png
:figclass: borderless
:alt: WPrefs.app expert user settings
WPrefs.app expert user settings
Using this panel implies some knowledge. Many options are available. Among
these are:
- Disabling miniwindows (useful when using with KDE and GNOME)
- Using (or not) xset
- Saving session on exit (highly recommended!)
- Using SaveUnder in different objects
- Using Win style cycling (added from version 0.63.0)
- Disabling confirmation panel for the kill command
- Disabling cycling colors highlighting of icons
- Multi head related options
- Screen edge snapping
Editing the configuration file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If needed, the defaults configuration file found in
$(HOME)/GNUstep/Defaults/WindowMaker can be edited by hand. This file is a
database with a property list syntax. When selecting an option in WPrefs.app,
it's written down into this file. When modifying this defaults file, it's very
important to follow the syntax.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Prefs</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

106
docs/guidedtour/title.css Normal file
View File

@@ -0,0 +1,106 @@
body {
color: #FFF;
font-size: 14pt;
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
background-color: #505075;
border-size: 2px;
margin-top: 0px;
margin-right: 12px;
margin-bottom: 0px;
margin-left: 12px;
}
.hpadding {
color: #483d8b;
font-weight: normal;
font-size: 14px;
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
padding: 0px 10px
}
.textpadding {
color: white;
font-size: 14px;
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
line-height: normal;
margin: 0;
padding: 0 10px
}
a {
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
}
table .inner {
margin-left: 1em;
width: 90%;
}
h1 {
color: #ebdeff;
font-size: 20pt;
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
font-style: italic;
font-weight: bold;
line-height: 22pt
}
h2 {
color: #ebdeff;
font-size: 18pt;
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
font-style: italic;
line-height: 20pt
}
h3 {
color: #e8fd00;
font-size: 14pt;
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
font-style: normal;
line-height: 16pt
}
h4 {
color: #FFF;
font-size: 12pt;
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif;
font-style: normal;
font-weight: bolder;
line-height: 12pt
}
.caption {
font-size: 11pt;
font-family: "Trebuchet MS", Arial, Helvetica, sans-serif
}
a:hover, a:focus {
text-decoration: underline;
font-style: italic;
color: #CCC;
}
a:link, a:visited, a:active {
text-decoration: underline;
color: #FFF;
}
img {
border: none;
}
#dock {
position: absolute; top: 100px; left: 5px;
}
#inhalt {
position: absolute; top: 40px; left: 100px;
min-width: 800px;
}
div.screenshot {
height: 250px;
border: none;
float: left;
margin: 5px;
}

349
docs/guidedtour/win.html Normal file
View File

@@ -0,0 +1,349 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Windows</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
<div class="document" id="windows">
<h1 class="title">Windows</h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>
<li><p><a class="reference internal" href="#focusing" id="id2">Focusing</a></p></li>
<li><p><a class="reference internal" href="#reordering" id="id3">Reordering</a></p></li>
<li><p><a class="reference internal" href="#moving" id="id4">Moving</a></p></li>
<li><p><a class="reference internal" href="#maximizing" id="id5">Maximizing</a></p></li>
<li><p><a class="reference internal" href="#miniaturizing" id="id6">Miniaturizing</a></p></li>
<li><p><a class="reference internal" href="#resizing" id="id7">Resizing</a></p></li>
<li><p><a class="reference internal" href="#shading" id="id8">Shading</a></p></li>
<li><p><a class="reference internal" href="#hiding" id="id9">Hiding</a></p></li>
<li><p><a class="reference internal" href="#closing" id="id10">Closing</a></p></li>
<li><p><a class="reference internal" href="#commands-menu" id="id11">Commands menu</a></p></li>
</ul>
</div>
<div class="section" id="description">
<h1>Description</h1>
<p>General layout of a window:</p>
<ul class="simple">
<li><p><em>Titlebar</em>: Gives the name of the application, document or window. It's color
(usually) indicates the focus state (active or inactive window). I say
(usually) because some styles and themes do not provide different colors for
focused or unfocused windows - although this is rare (and, I might add,
cruel!).</p></li>
<li><p><em>Miniaturize button</em>: Clicking on the left button of the titlebar iconifies
the window.</p></li>
<li><p><em>Close button</em>: Clicking on the right button of the titlebar closes the
window or kills the application.</p></li>
<li><p><em>Resizebar</em>: The bottom part of the window. Dragging the resizebar with the
mouse resizes the window.</p></li>
<li><p><em>Client area</em>: The window content. It can be an application, some text, a
picture...</p></li>
</ul>
</div>
<div class="section" id="focusing">
<h1>Focusing</h1>
<p>A window can be in two states: focused or unfocused. The focused window is the
active window, the one receiving keystrokes. It's titlebar has a differentiated
color (usually!). Dialog windows or panels opened from a main window,
automatically get the focus. As soon as they are closed, the main window gets
the focus back.</p>
<p>Two modes are available to focus a window:</p>
<ul class="simple">
<li><p><em>Click to focus mode</em>: clicking on any part of the window activates it.</p></li>
<li><p><em>Focus follows mouse mode</em>: moving the mouse pointer over the window
activates it.</p></li>
</ul>
</div>
<div class="section" id="reordering">
<h1>Reordering</h1>
<p>Windows can overlap other windows, in which case some will hide all or part of
others. Clicking on the titlebar or resizebar with the left mouse button brings
a window to the "front" (gives that window focus). Selecting a window from the
window list menu does the same.</p>
<p>Some key bindings are provided and are very useful when a window is hidden
behind others.</p>
<ul>
<li>
<p><em>Meta key + click on the titlebar with left mouse button</em>-</p>
<p>sends the window to the back and gives focus to the topmost window.</p>
</li>
<li>
<p><em>Meta key + click on the client area with left mouse button</em>-</p>
<p>brings the window to the front and focuses it.</p>
</li>
<li>
<p><em>Meta key + Up Arrow key</em>-</p>
<p>brings the current focused window to the front.</p>
</li>
<li>
<p><em>Meta key + Down Arrow key</em>-</p>
<p>sends the current focused window to the back.</p>
</li>
</ul>
<p>Many window attributes can be modified from the attributes panel in the window
commands menu (clicking the right mouse button on the titlebar). From version
0.62.0, window cycling was changed to Windows style (Alt-Tab).</p>
</div>
<div class="section" id="moving">
<h1>Moving</h1>
<p>Clicking on the titlebar of a window and dragging it with the left mouse button
pressed moves the window. The little box in the middle indicates the current
position in pixels relative to the top left corner of the screen (+0 +0). Extra
key bindings give more flexibility.</p>
<ul class="simple">
<li><p>Dragging the titlebar with middle mouse button: moves the window
without changing it's stacking order.</p></li>
<li><p>Dragging the titlebar + Ctrl key: moves the window without focusing it.</p></li>
<li><p>Dragging the client area or the resizebar + Meta key: moves the window.</p></li>
</ul>
</div>
<div class="section" id="maximizing">
<h1>Maximizing</h1>
<p>Double-clicking the titlebar while holding the Ctrl key resizes the window's
height to full screen.</p>
<p>Double-clicking the titlebar while holding the Shift key resizes the window's
width to full screen.</p>
<p>Double-clicking the titlebar while holding both Ctrl and Shift keys resizes the
window's height and width to full screen. Double-clicking the titlebar while
holding Ctrl or Shift key restores the initial size of the window.</p>
<p>To prevent a maximized window from covering the dock, the "Keep on top" option
must be selected from the dock menu.</p>
</div>
<div class="section" id="miniaturizing">
<h1>Miniaturizing</h1>
<p>Clicking the miniaturize button (the left one on the titlebar) shrinks the
window into a miniwindow with an icon and a title and places it at the bottom
of the screen. Hitting the assigned shortcut does the same. (Default is Meta +
m.)</p>
<p>The miniwindow is different from the application icon in that the miniwindow
cannot be docked.</p>
<p>Double-clicking in the miniwindow restores a miniaturized window.
Double-clicking in an application icon with the middle mouse button restores
all miniaturized and hidden windows of this application.</p>
</div>
<div class="section" id="resizing">
<h1>Resizing</h1>
<p>The resizebar, at the bottom of the window, is divided into three regions: left
end region, middle region and right end region.</p>
<p>Depending upon the region you click, the resize operation is constrained to one
direction.</p>
<p>Clicking in the middle region of the resizebar and dragging it vertically
changes the window's height.</p>
<p>Clicking in either the left or right region of the resizebar and dragging it
horizontally changes the window's width.</p>
<p>Dragging with Shift key pressed gives the same result. Clicking in either end
region of the resizebar and dragging it diagonally changes both height and
width.</p>
<p>Key bindings give more options.</p>
<ul class="simple">
<li><p>Dragging the window in the client area with the right mouse button + Meta key
resizes the window.</p></li>
<li><p>Dragging the resizebar with the middle mouse button resizes the window
without bringing it to the front.</p></li>
<li><p>Dragging the resizebar + Ctrl key resizes the window without focusing it.</p></li>
</ul>
</div>
<div class="section" id="shading">
<h1>Shading</h1>
<p>Double-clicking on the titlebar of a window shades it. This means the window
rolls up to it's titlebar. A shaded window has almost the same properties as a
normal window. It can be miniaturized or closed.</p>
<p>From version 0.80.0, you can shade/unshade a window using a mouse wheel on its
titlebar. This of course, assumes your system is able to manage a mouse wheel.
The WMGLOBAL file in you $HOME/GNUstep/Defaults should contain two new
directives : MouseWheelUp and MouseWheelDown.</p>
</div>
<div class="section" id="hiding">
<h1>Hiding</h1>
<p>Clicking the the miniaturize button (the left one on the titlebar) with the
right mouse button hides the application. Using the middle mouse button unhides
the application, simultaneously opening the windows list menu and selecting the
hidden application. (Pressing both buttons at once with a two buttons mouse
does the same on some OSes.) If this doesn't work, use the F11 key binding (the
default) to open the windows list menu.</p>
</div>
<div class="section" id="closing">
<h1>Closing</h1>
<p>Clicking the close button (the right one on the titlebar) closes the window.
When the close button has a different form (not an X), it means an application
is running in that window. Double-clicking in this close button kills the
application. This can be done too with <em>Ctrl key + clicking the close button</em>.</p>
<p>Usually, it's much better to exit an application from inside (through it's
menu, for instance).</p>
</div>
<div class="section" id="commands-menu">
<h1>Commands menu</h1>
<p>Clicking on the titlebar of a window with the right mouse button opens a menu
containing commands applying to this window. The keyboard shortcut Ctrl + Esc
can replace the click on the titlebar. Esc closes this menu.</p>
<div class="section" id="list-of-commands-menu-commands">
<h2>List of Commands Menu commands:</h2>
<p><em>Maximize/Unmaximize</em>:</p>
<p>Either maximizes or returns the window to it's initial state.</p>
<p><em>Miniaturize</em>:</p>
<p>Miniaturizes the window (miniwindow). The keyboard shortcut is Meta + m.</p>
<p><em>Shade/Unshade</em>: Shades (or unshades) the window.</p>
<p><em>Hide</em>:</p>
<p>Hides all windows of the application. Clicking on the application icon unhides
the windows.</p>
<p><em>Hide Others</em>:</p>
<p>From version 0.80.1 it is possible to hide all others windows. The window list
menu allows to unhide selecting the window to redisplay.</p>
<p><em>Resize/Move</em>:</p>
<p>When this menu option is selected, the window is ready to be moved or resized
(the little box with coordinates is displayed inside the window). Clicking on
the titlebar deselects the option.</p>
<p><em>Select</em>:</p>
<p>Obviously selects the window which then can be moved or resized... Reselecting
this option deselects the window.</p>
<p><em>Move to</em>:</p>
<p>Allows to move the window to another workspace (if existing!).</p>
<p><em>Attributes</em>:</p>
<p>Opens the attributes panel to edit attributes and options for the window.</p>
<p>Five options are available in this panel: Window specification, Window
attributes, Advanced options, Icon and initial workspace and application
specific.</p>
<ul class="simple">
<li><p>Window specification: Defines that the configuration will apply to windows
having their WM_CLASS property set to the selected name. This is because
windows can have different names. From version 0.65.0, you can select the
window to get the right specification.</p></li>
<li>
<p>Window attributes: selecting the corresponding checkbox allows to:</p>
<ul>
<li><p>disable titlebar</p></li>
<li><p>disable resizebar</p></li>
<li><p>disable close button</p></li>
<li><p>disable miniaturize button</p></li>
<li><p>disable border</p></li>
<li><p>keep on top</p></li>
<li><p>keep at bottom</p></li>
<li><p>omnipresent</p></li>
<li><p>start miniaturized</p></li>
<li><p>start maximized</p></li>
<li><p>full screen maximization</p></li>
</ul>
</li>
<li>
<p>Advanced options: selecting the corresponding checkbox allows to:</p>
<ul>
<li><p>don't bind keyboard shortcuts</p></li>
<li><p>don't bind mouse clicks</p></li>
<li><p>don't show in the window list</p></li>
<li><p>don't let the window take focus</p></li>
<li><p>keep inside screen</p></li>
<li><p>ignore "Hide others"</p></li>
<li><p>ignore "Save session"</p></li>
<li><p>emulate application icon</p></li>
</ul>
</li>
<li>
<p>Icon and initial workspace: allow to</p>
<ul>
<li><p>choose an icon browsing directories</p></li>
<li><p>ignore client supplied icon when selecting the checkbox</p></li>
<li><p>define initial workspace</p></li>
</ul>
</li>
<li>
<p>Application specific: selecting checkboxes allows to:</p>
<ul>
<li><p>start hidden or with no application icon</p></li>
<li><p>collapse application icons (from version 0.65.0)</p></li>
</ul>
</li>
<li><p>From version 0.80.0 a new checkbox is available : "Shared application icon".
It replaces the "Collapse application icon" checkbox. That is, you can have
many open windows from the same application with only one appicon. This
feature is on by default except for some incompatible applications. This
behavior can be defined for all windows in the Window Specification inspector
selecting the Defaults for all windows checkbox.</p></li>
</ul>
<p>You can revert to the old behavior changing SharedAppIcon to "No" in the
WMWindowAttributes file, either in the global domain or in the local domain :
$HOME/GNUstep/Defaults.</p>
<p><em>Options</em>:</p>
<p>Submenu options allow to:</p>
<ul class="simple">
<li><p>to keep the window on top</p></li>
<li><p>to keep the window at bottom</p></li>
<li><p>to keep the window omnipresent</p></li>
<li><p>to set shortcuts for the window</p></li>
</ul>
<p>Ten shortcuts are available as soon as they have been set in the keyboard
shortcut dialog. The shortcuts to define are those named "Shortcut for window +
figure". Then, using the defined shortcut gives the focus to the window.</p>
<p><em>Close</em>:</p>
<p>Closes the window</p>
<p><em>Kill</em>:</p>
<p>Kills the application. Usually, an application must be closed from inside (menu
or other means). This option is especially reserved for "emergency" cases.</p>
</div>
</div>
</div>
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Windows</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>

373
docs/guidedtour/win.rst Normal file
View File

@@ -0,0 +1,373 @@
<!DOCTYPE html>
<html>
<head>
<title>Window Maker: Guided Tour - Windows</title>
<meta charset="utf-8">
<link rel="stylesheet" href="/style.css" media="screen">
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport"
content="width=device-width, minimumscale=1.0, maximum-scale=1.0">
</head>
<body>
<div id="wrapper">
<header>
<h1>
<a href="/">
<span class="first">Window</span><span class="second">Maker</span>
</a>
</h1>
</header>
<aside>
<nav class="menu">
<ul>
<li id="dock">
<a href="#"></a>
</li>
<li id="home" title="Home">
<a href="/">Home</a>
</li>
<li id="news" title="News">
<a href="/news">News</a>
</li>
<li id="docs" title="Documentation">
<a href="/docs">Documentation</a>
</li>
<li id="mail" title="Mailing lists">
<a href="/lists">Mailing</a>
</li>
<li id="devel" title="Development">
<a href="/dev">Development</a>
</li>
<li id="screenshots" title="Screenshots">
<a href="/screenshots">Screenshots</a>
</li>
<li id="themes" title="Themes">
<a href="/themes">Themes</a>
</li>
<li id="links" title="Links">
<a href="/links">Links</a>
</li>
</ul>
</nav>
</aside>
<article>
Windows
=======
.. contents::
:depth: 1
:backlinks: none
:local:
Description
-----------
General layout of a window:
- *Titlebar*: Gives the name of the application, document or window. It's color
(usually) indicates the focus state (active or inactive window). I say
(usually) because some styles and themes do not provide different colors for
focused or unfocused windows - although this is rare (and, I might add,
cruel!).
- *Miniaturize button*: Clicking on the left button of the titlebar iconifies
the window.
- *Close button*: Clicking on the right button of the titlebar closes the
window or kills the application.
- *Resizebar*: The bottom part of the window. Dragging the resizebar with the
mouse resizes the window.
- *Client area*: The window content. It can be an application, some text, a
picture...
Focusing
--------
A window can be in two states: focused or unfocused. The focused window is the
active window, the one receiving keystrokes. It's titlebar has a differentiated
color (usually!). Dialog windows or panels opened from a main window,
automatically get the focus. As soon as they are closed, the main window gets
the focus back.
Two modes are available to focus a window:
- *Click to focus mode*: clicking on any part of the window activates it.
- *Focus follows mouse mode*: moving the mouse pointer over the window
activates it.
Reordering
----------
Windows can overlap other windows, in which case some will hide all or part of
others. Clicking on the titlebar or resizebar with the left mouse button brings
a window to the "front" (gives that window focus). Selecting a window from the
window list menu does the same.
Some key bindings are provided and are very useful when a window is hidden
behind others.
- *Meta key + click on the titlebar with left mouse button*-
sends the window to the back and gives focus to the topmost window.
- *Meta key + click on the client area with left mouse button*-
brings the window to the front and focuses it.
- *Meta key + Up Arrow key*-
brings the current focused window to the front.
- *Meta key + Down Arrow key*-
sends the current focused window to the back.
Many window attributes can be modified from the attributes panel in the window
commands menu (clicking the right mouse button on the titlebar). From version
0.62.0, window cycling was changed to Windows style (Alt-Tab).
Moving
------
Clicking on the titlebar of a window and dragging it with the left mouse button
pressed moves the window. The little box in the middle indicates the current
position in pixels relative to the top left corner of the screen (+0 +0). Extra
key bindings give more flexibility.
- Dragging the titlebar with middle mouse button: moves the window
without changing it's stacking order.
- Dragging the titlebar + Ctrl key: moves the window without focusing it.
- Dragging the client area or the resizebar + Meta key: moves the window.
Maximizing
----------
Double-clicking the titlebar while holding the Ctrl key resizes the window's
height to full screen.
Double-clicking the titlebar while holding the Shift key resizes the window's
width to full screen.
Double-clicking the titlebar while holding both Ctrl and Shift keys resizes the
window's height and width to full screen. Double-clicking the titlebar while
holding Ctrl or Shift key restores the initial size of the window.
To prevent a maximized window from covering the dock, the "Keep on top" option
must be selected from the dock menu.
Miniaturizing
-------------
Clicking the miniaturize button (the left one on the titlebar) shrinks the
window into a miniwindow with an icon and a title and places it at the bottom
of the screen. Hitting the assigned shortcut does the same. (Default is Meta +
m.)
The miniwindow is different from the application icon in that the miniwindow
cannot be docked.
Double-clicking in the miniwindow restores a miniaturized window.
Double-clicking in an application icon with the middle mouse button restores
all miniaturized and hidden windows of this application.
Resizing
--------
The resizebar, at the bottom of the window, is divided into three regions: left
end region, middle region and right end region.
Depending upon the region you click, the resize operation is constrained to one
direction.
Clicking in the middle region of the resizebar and dragging it vertically
changes the window's height.
Clicking in either the left or right region of the resizebar and dragging it
horizontally changes the window's width.
Dragging with Shift key pressed gives the same result. Clicking in either end
region of the resizebar and dragging it diagonally changes both height and
width.
Key bindings give more options.
- Dragging the window in the client area with the right mouse button + Meta key
resizes the window.
- Dragging the resizebar with the middle mouse button resizes the window
without bringing it to the front.
- Dragging the resizebar + Ctrl key resizes the window without focusing it.
Shading
-------
Double-clicking on the titlebar of a window shades it. This means the window
rolls up to it's titlebar. A shaded window has almost the same properties as a
normal window. It can be miniaturized or closed.
From version 0.80.0, you can shade/unshade a window using a mouse wheel on its
titlebar. This of course, assumes your system is able to manage a mouse wheel.
The WMGLOBAL file in you $HOME/GNUstep/Defaults should contain two new
directives : MouseWheelUp and MouseWheelDown.
Hiding
------
Clicking the the miniaturize button (the left one on the titlebar) with the
right mouse button hides the application. Using the middle mouse button unhides
the application, simultaneously opening the windows list menu and selecting the
hidden application. (Pressing both buttons at once with a two buttons mouse
does the same on some OSes.) If this doesn't work, use the F11 key binding (the
default) to open the windows list menu.
Closing
-------
Clicking the close button (the right one on the titlebar) closes the window.
When the close button has a different form (not an X), it means an application
is running in that window. Double-clicking in this close button kills the
application. This can be done too with *Ctrl key + clicking the close button*.
Usually, it's much better to exit an application from inside (through it's
menu, for instance).
Commands menu
-------------
Clicking on the titlebar of a window with the right mouse button opens a menu
containing commands applying to this window. The keyboard shortcut Ctrl + Esc
can replace the click on the titlebar. Esc closes this menu.
List of Commands Menu commands:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*Maximize/Unmaximize*:
Either maximizes or returns the window to it's initial state.
*Miniaturize*:
Miniaturizes the window (miniwindow). The keyboard shortcut is Meta + m.
*Shade/Unshade*: Shades (or unshades) the window.
*Hide*:
Hides all windows of the application. Clicking on the application icon unhides
the windows.
*Hide Others*:
From version 0.80.1 it is possible to hide all others windows. The window list
menu allows to unhide selecting the window to redisplay.
*Resize/Move*:
When this menu option is selected, the window is ready to be moved or resized
(the little box with coordinates is displayed inside the window). Clicking on
the titlebar deselects the option.
*Select*:
Obviously selects the window which then can be moved or resized... Reselecting
this option deselects the window.
*Move to*:
Allows to move the window to another workspace (if existing!).
*Attributes*:
Opens the attributes panel to edit attributes and options for the window.
Five options are available in this panel: Window specification, Window
attributes, Advanced options, Icon and initial workspace and application
specific.
- Window specification: Defines that the configuration will apply to windows
having their WM_CLASS property set to the selected name. This is because
windows can have different names. From version 0.65.0, you can select the
window to get the right specification.
- Window attributes: selecting the corresponding checkbox allows to:
- disable titlebar
- disable resizebar
- disable close button
- disable miniaturize button
- disable border
- keep on top
- keep at bottom
- omnipresent
- start miniaturized
- start maximized
- full screen maximization
- Advanced options: selecting the corresponding checkbox allows to:
- don't bind keyboard shortcuts
- don't bind mouse clicks
- don't show in the window list
- don't let the window take focus
- keep inside screen
- ignore "Hide others"
- ignore "Save session"
- emulate application icon
- Icon and initial workspace: allow to
- choose an icon browsing directories
- ignore client supplied icon when selecting the checkbox
- define initial workspace
- Application specific: selecting checkboxes allows to:
- start hidden or with no application icon
- collapse application icons (from version 0.65.0)
- From version 0.80.0 a new checkbox is available : "Shared application icon".
It replaces the "Collapse application icon" checkbox. That is, you can have
many open windows from the same application with only one appicon. This
feature is on by default except for some incompatible applications. This
behavior can be defined for all windows in the Window Specification inspector
selecting the Defaults for all windows checkbox.
You can revert to the old behavior changing SharedAppIcon to "No" in the
WMWindowAttributes file, either in the global domain or in the local domain :
$HOME/GNUstep/Defaults.
*Options*:
Submenu options allow to:
- to keep the window on top
- to keep the window at bottom
- to keep the window omnipresent
- to set shortcuts for the window
Ten shortcuts are available as soon as they have been set in the keyboard
shortcut dialog. The shortcuts to define are those named "Shortcut for window +
figure". Then, using the defined shortcut gives the focus to the window.
*Close*:
Closes the window
*Kill*:
Kills the application. Usually, an application must be closed from inside (menu
or other means). This option is especially reserved for "emergency" cases.
</article>
<div id="titlebar">
<div id="minimize"></div>
<div id="titlebar-inner">Window Maker: Guided Tour - Windows</div>
<div id="close"></div>
</div>
<div id="resizebar">
<div id="resizel"></div>
<div id="resizebar-inner">
</div>
<div id="resizer"></div>
</div>
</div>
</body>
</html>