haiku/3rdparty/mmu_man/themes/doc
François Revol b0857aa924 Add some documentation for Themes.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@27905 a95241bf-73f2-0310-859d-f6bbb57e9c96
2008-10-07 18:03:09 +00:00
..
images
README.html

README.html

<html>
<head>
<title>
Theme Manager for BeOS and Haiku
</title>
</head>
<body>
<h1>Theme Manager for <font color="blue">B</font><font color="red">e</font>OS and Haiku</h1>
&copy; 2000-2008, Fran&ccedil;ois Revol.

<h2>About</h2>
<p>
Theme Manager allows you to change the appearance of BeOS (R5, Dano0 and Zeta) and Haiku.
It packages various interface settings in a single file and allows applying them on the fly.
</p>

<h2>Licence</h2>
<p>
Theme Manager is distributed under the MIT licence.<br />
Sources are available in the Haiku <a href="http://dev.haiku-os.org/browser/haiku/trunk/3rdparty/mmu_man/themes">subversion repository</a>, and documented <a href="http://www.haiku-os.org/blog/mmu_man/2008-01-25/the_bowels_of_the_theme_manager_or_how_to_make_haiku_as_ugly_as_zeta">here</a> and <a href="http://www.haiku-os.org/blog/mmu_man/2008-02-01/even_more_themes">there</a>.
</p>
<h2>Features</h2>
<p>There are a many settings that are saved and restored by Theme Manager, depending on the platform. For example BeOS R5 doesn't support changing system colors. Each feature can be selectively disabled for applying and saving.
</p>
<dl>
<dt><strong>Backgrounds</strong></dt>
<dd>Wallpapers and background color</dd>
<dt><strong>BeIDE Colors</strong></dt>
<dd>Applies the system document colors to BeIDE.</dd>
<dt><strong>Deskbar</strong></dt>
<dd>Saves and restores Deskbar location.</dd>
<dt><strong>Eddie Colors</strong></dt>
<dd>Applies the system document colors to the <a href="http://bebits.com/app/95">Eddie</a> editor.</dd>
<dt><strong>Pe Colors</strong></dt>
<dd>Applies the system document colors to the <a href="http://bebits.com/app/3864">Pe</a> editor.</dd>
<dt><strong>Screensaver</strong></dt>
<dd>Saves and restores the screensaver and its settings.</dd>
<dt><strong>SoundPlay Color</strong></dt>
<dd>Applies the system colors to running instances of <a href="http://bebits.com/app/156">SoundPlay</a> by simulating a color drop on the window.</dd>
<dt><strong>Sounds</strong></dt>
<dd>Saves and restores system sounds.</dd>
<dt><strong>Terminal</strong></dt>
<dd>Saves and restores the Terminal fonts, colors and size.</dd>
<dt><strong>System Colors and Fonts</strong></dt>
<dd>Saves and restores system colors and fonts.</dd>
<dt><strong>Winamp Skin</strong></dt>
<dd>Saves and restores the selected Winamp skin of both <a href="http://bebits.com/app/52">CL-Amp</a> and <a href="http://bebits.com/app/156">SoundPlay</a>.</dd>
<dt><strong>Window Decor</strong></dt>
<dd>Saves and restores the window decor.</dd>
</dl>
<p>Changing icons isn't yet supported.</p>
<h3>BeTheme Import</h3>
BeTheme themes are searched for on BFS partitions and imported. Icons aren't supported yet, but backgrounds, deskbar position and window decor are supported.
<h3>MSTheme Import</h3>
MS .theme files are searched for on NTFS partitions and imported. Icons aren't supported yet, but colors and sounds are applied, window decor and deskbar position are forced to mimic Windows.
<h3>Feature Grid</h3>
<table border="1">
<tr><td>Feature</td><td>R5</td><td>Dano/Zeta</td><td>Haiku</td><td>BeTheme (import)</td><td>MSTheme (import)</td></tr>
<tr><td>Backgrounds</td><td>X</td><td>X</td><td>X</td><td>X</td><td>X</td></tr>
<tr><td>BeIDE Colors</td><td>X</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>Deskbar</td><td>X</td><td>X</td><td>X</td><td>X</td><td>(forced)</td></tr>
<tr><td>Eddie Colors</td><td>X</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>Pe Colors</td><td>X</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>Screensaver</td><td>X</td><td>X</td><td>X</td><td></td><td>X</td></tr>
<tr><td>SoundPlay Color</td><td>X</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>Sounds</td><td>X</td><td>X</td><td>X</td><td></td><td>X</td></tr>
<tr><td>Terminal</td><td>X</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>System Colors</td><td></td><td>X</td><td>X</td><td></td><td>X</td></tr>
<tr><td>System Fonts</td><td>X</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>Winamp Skin</td><td>X</td><td>X</td><td>X</td><td></td><td></td></tr>
<tr><td>Window Decor</td><td>X</td><td>X</td><td>X</td><td>X</td><td>X</td></tr>
</table>

<h2>Installation</h2>
<h3>Application</h3>
Just unzip the version of the Themes binary you need.
<h3>Themes</h3>
Themes are stored in folders containing a plain text "Theme" descriptor file, optionally a screenshot file for the preview, and eventually other files (bitmaps, sounds...). 
Themes folders go to <a href="file:///boot/home/config/settings/UIThemes/">~/config/settings/UIThemes/</a>.

<h2>Usage</h2>
The interface should be self-describing.
<br />
On the left themes are listed, native first, then imported ones. Read-only theme items (from /etc/UIThemes and imported) have a different item background color.
<br />
The "New" button creates a new empty theme.
<br />
The "Save" button saves the current settings to the selected theme.
<br />
The "Delete" button moves the selected theme (its folder and files) to the Trash, from where it can eventually be recovered.
<br />
The "Add Screenshot" hides Themes window, takes a screenshot and attaches it to the selected theme.
<br />
The "Apply" button changes settings to match the selected theme.
<br />
<img src="images/shot_themes_001.png" />
<br />
The "Show Options" button brings a list of checkboxes to enable or disable selectively each feature on theme change. Click "Show Preview" to go back to the preview display.
<br />
<img src="images/shot_themes_002.png" />
<br />

</body>
</html>