Added theme pack documentation
authorDoug Torrance <torrance@vandals.uidaho.edu>
Sun, 13 Oct 2013 22:41:50 +0000 (13 17:41 -0500)
committerCarlos R. Mafra <crmafra@gmail.com>
Sun, 13 Oct 2013 23:02:37 +0000 (14 00:02 +0100)
There were some broken links in the FAQ to documentation on creating
theme packs, originally hosted on largo.windowmaker.org.

These pages were located on archive.org and reformatted to fit the
website's current style.

FAQ.php
example-lsm.txt [new file with mode: 0644]
theme-HOWTO-dirs.php [new file with mode: 0644]
theme-HOWTO-gifs.php [new file with mode: 0644]
theme-HOWTO-tar.php [new file with mode: 0644]
theme-HOWTO.php [new file with mode: 0644]
themepacks.php [new file with mode: 0644]

diff --git a/FAQ.php b/FAQ.php
index f6a82c0..4df3dc7 100644 (file)
--- a/FAQ.php
+++ b/FAQ.php
@@ -1832,8 +1832,7 @@ Themes are a great aspect of Window Maker allowing a user to simply
 save the entire 'look' of their desktop in an archive to distribute freely among
 friends, fellow users and/or the whole net in general. :)
 <P>
-See the theme-HOWTO at <A HREF="http://largo.windowmaker.org/themes/themepacks.php">http://largo.windowmaker.org/themes/themepacks.php</A>
-for an in-depth walk-through on making a Theme archive.
+See the <a href="themepacks.php">theme-HOWTO</a> for an in-depth walk-through on making a Theme archive.
 <A name="122"></A>
 <h2>6.2 &nbsp;How do I install a theme?</h2>
 This should be as simple as untarring the Theme.tar.gz into one of two
@@ -1861,8 +1860,7 @@ If libjpeg is not listed, you will need to install libjpeg that is available
 from ftp.windowmaker.org
 <A name="124"></A>
 <h2>6.4 &nbsp;How do I make a Theme?</h2>
-Please see the theme-HOWTO at <A HREF="http://largo.windowmaker.org/themes/themepacks.php">http://largo.windowmaker.org/themes/themepacks.php</A>
-for details on making both new and old style themes (and the differences
+Please see the <a href="themepacks.php">theme-HOWTO</a> for details on making both new and old style themes (and the differences
 between the two), here is a short summary on making old style themes.
 Also, read the README.themes file included with the Window Maker
 distribution in the WindowMaker/ directory.
diff --git a/example-lsm.txt b/example-lsm.txt
new file mode 100644 (file)
index 0000000..0d8b897
--- /dev/null
@@ -0,0 +1,7 @@
+Theme Name      : Foobar
+Author          : Chuck Effbiesdee <chuck@effbiesdee.com>
+Description     : A theme about being Chuck and stuff such as that.
+Copyright       : Chuck Effbiesdee background is courtesy of
+                  www.chuck-effbiesdee.com
+                  Background is in .jpg format.
+                  Colors, tiles and title/menu bars are courtesy of me.
diff --git a/theme-HOWTO-dirs.php b/theme-HOWTO-dirs.php
new file mode 100644 (file)
index 0000000..8c38193
--- /dev/null
@@ -0,0 +1,36 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta name="generator" content="HTML Tidy for Linux (vers 25 March 2009), see www.w3.org" />
+
+  <title>Window Maker: Themes</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
+  <link href="title.css" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+  <?php include("dock.php");  ?>
+  <?php include("header.php"); ?>
+
+<table class="inner" border="0" cellpadding="1" cellspacing="1">
+      <tr>
+        <td content="content" colspan="2" valign="top">
+          <br />
+          <br />
+
+Please use only Window Maker standard directory sructures. This means don't 
+       stick your titlebars in a directory under "~/GNUstep/Library/WindowMaker/Titlebars"
+       and your Tiles under "~/GNUstep/Library/WindowMaker/Tiles". Please use 
+       <tt>~/GNUstep/Library/WindowMaker/Pixmaps</tt> for all tiles and menu/titlebar images,   
+       <tt>~/GNUstep/Library/WindowMaker/Icons</tt> for any icons you include
+       and <tt>~/GNUstep/Library/WindowMaker/Backgrounds</tt> for your backgrounds.
+       <br><br>
+
+
+ </td>
+      </tr>
+    </table>
+
+  <?php include("footer.php"); ?>
+
+</body>
+</html>
diff --git a/theme-HOWTO-gifs.php b/theme-HOWTO-gifs.php
new file mode 100644 (file)
index 0000000..a86a329
--- /dev/null
@@ -0,0 +1,41 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta name="generator" content="HTML Tidy for Linux (vers 25 March 2009), see www.w3.org" />
+
+  <title>Window Maker: Themes</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
+  <link href="title.css" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+  <?php include("dock.php");  ?>
+  <?php include("header.php"); ?>
+
+<table class="inner" border="0" cellpadding="1" cellspacing="1">
+      <tr>
+        <td content="content" colspan="2" valign="top">
+          <br />
+          <br />
+
+       Please do not use gifs or other large file formats as your background images. 
+       Although Window Maker does now include .gif support,
+       most backgrounds (unless they are small tiles) are at least 640x480.
+       and this makes for a <b>huge</b> gif file, generally in the 1meg+ range.<br>
+       The same file as a .jpg could be as much as 95% smaller or more!<br>
+       (also see <a href="http://www.gnu.org/philosophy/gif.html">here</a> for another good 
+       reason not to use GIFs), 
+       <br><br>
+       Also when using an image as the Background, if you choose to remove the file 
+       extension, please include the file format of it in the .lsm for your theme. 
+       <a href="example-lsm.txt">See here</a> for an example <tt>readme.lsm</tt> file.
+       <br><br>
+
+
+ </td>
+      </tr>
+    </table>
+
+  <?php include("footer.php"); ?>
+
+</body>
+</html>
diff --git a/theme-HOWTO-tar.php b/theme-HOWTO-tar.php
new file mode 100644 (file)
index 0000000..88a9817
--- /dev/null
@@ -0,0 +1,63 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta name="generator" content="HTML Tidy for Linux (vers 25 March 2009), see www.w3.org" />
+
+  <title>Window Maker: Themes</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
+  <link href="title.css" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+  <?php include("dock.php");  ?>
+  <?php include("header.php"); ?>
+
+<table class="inner" border="0" cellpadding="1" cellspacing="1">
+      <tr>
+        <td content="content" colspan="2" valign="top">
+          <br />
+          <br />
+
+
+       Here's a quick guide to tar'ing your theme up:<br>
+       cd to your <tt>~/GNUstep/Library/WindowMaker/</tt> directory, and type something like
+       the following: (replacing the file names appropriately for your theme)
+       </font>
+       <p>
+
+       <ol>
+         <li> <tt>tar -cvf Foo.tar Foo.lsm Backgrounds/FooBG.jpg Pixmaps/FooTile.xpm 
+              Icons/FooIcon.xpm Themes/Foo</tt>
+              <br><br>
+          <li> <tt>gzip -9 Foo.tar</tt>
+              <br><br>
+       </ol>
+
+       This should leave you with a nice new <tt>Foo.tar.gz</tt> theme which includes (in this case),
+       the theme file (<tt>Themes/Foo</tt>), the background wallpaper (<tt>Backgrounds/FooBG.jpg</tt>), 
+       a tile (<tt>Pixmaps/FooTile.xpm</tt>), an icon for the dock (<tt>Icons/FooIcon.xpm</tt>) 
+       and a readme file (<tt>Foo.lsm</tt>).<br>
+       LSM files for your themes are a must. The format of the LSM file is
+       easy. Click <a href="example-lsm.txt">here</a> for an example. 
+       <p>
+       If you're having trouble, try typing '<tt>man tar</tt>' or ask for help on irc 
+       in the #WindowMaker channel on EFnet. If all else fails, you can 
+       <a href="wmaker-dev.php">contact us</a> and we'll try and help you out,
+       but please try the other methods first. Thanks.
+       <p>
+       Also, your theme file should NOT include your <tt>~/GNUstep/Defaults/WindowMaker</tt> 
+       file! This will overwrite the person who downloads the theme's keybindings 
+       and other personalized settings. 
+       Also do NOT include any files other those from the directories I mentioned 
+       above. For example, do NOT include your <tt>menu</tt> file or anything from your
+       <tt>~/GNUstep/Defaults/</tt> directory. ONLY include files from the directories 
+       listed above and the readme.lsm file.
+
+
+ </td>
+      </tr>
+    </table>
+
+  <?php include("footer.php"); ?>
+
+</body>
+</html>
diff --git a/theme-HOWTO.php b/theme-HOWTO.php
new file mode 100644 (file)
index 0000000..e3d78a3
--- /dev/null
@@ -0,0 +1,71 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta name="generator" content="HTML Tidy for Linux (vers 25 March 2009), see www.w3.org" />
+
+  <title>Window Maker: Themes</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
+  <link href="title.css" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+  <?php include("dock.php");  ?>
+  <?php include("header.php"); ?>
+
+<table class="inner" border="0" cellpadding="1" cellspacing="1">
+      <tr>
+        <td content="content" colspan="2" valign="top">
+          <br />
+          <br />
+
+<h1>Theme HOWTO</h1>
+<b>WARNING: This is for OLD style theme's only as is OUT OF DATE. Support for this format may be dropped
+eventually and is not actively supported. Use this at your own risk!! Unless you have reason to do otherwise,
+PLEASE use the <a href="themepacks.php">new ThemePack format</a>!!!</b>
+
+<p>
+
+For those of you that like to get in there and do it yourselves, or just want a theme
+that is truely yours, here are some helpful guidelines to follow to have your theme
+be as simple, standard and user friendly as possible. See <a href="themepacks.php">here</a>
+for info on the new ThemePack format.
+
+<p align="right">
+Have fun!<br>
+
+
+<font size="5">
+<i>-Largo</i>
+</font>
+</p>
+
+<br>
+
+<ul>
+  <li> 
+       tar up your theme so that if the user untars it while in his/her
+       <tt>~/GNUstep/Library/WindowMaker</tt>...the theme will instantly appear in their menu.
+       <a href="theme-HOWTO-tar.php">Here's a quick guide to tar'ing your theme up</a>.
+       <br><br>
+
+  <li>    Please use only Window Maker standard directory sructures. <a href="theme-HOWTO-dirs.php">details</a>
+       <br><br>
+
+  <li> 
+       Please use jpeg's as your background images. <a href="theme-HOWTO-gifs.php">details</a>
+       <br><br>
+
+</ul>
+
+All set! Now you can share it with your friends. :)<br>
+If you have any further questions, or comments on possible additions to this HOWTO, please
+<a href="wmaker-dev.php">let us know</a>. Thanks!
+
+
+ </td>
+      </tr>
+    </table>
+
+  <?php include("footer.php"); ?>
+
+</body>
+</html>
diff --git a/themepacks.php b/themepacks.php
new file mode 100644 (file)
index 0000000..a46426d
--- /dev/null
@@ -0,0 +1,124 @@
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta name="generator" content="HTML Tidy for Linux (vers 25 March 2009), see www.w3.org" />
+
+  <title>Window Maker: Themes</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
+  <link href="title.css" rel="stylesheet" type="text/css" />
+</head>
+
+<body>
+  <?php include("dock.php");  ?>
+  <?php include("header.php"); ?>
+
+<table class="inner" border="0" cellpadding="1" cellspacing="1">
+      <tr>
+        <td content="content" colspan="2" valign="top">
+          <br />
+          <br />
+
+  
+<h1>ThemePacks HOWTO</h1>
+
+<h2>Themes (Theme Packs) For Window Maker</h2>
+   
+<b>Note:</b> the information contained in this file is only valid for themes
+in the <tt>.themed</tt> (for theme directory) format, supported in 
+Window Maker 0.50.0 or newer. See <a href="theme-HOWTO.php">here</a> for 
+information on themes for WindowMaker-0.20.3 and earlier.
+<br><br><br>
+
+
+<h2>How To Install a Theme Pack</h2>
+
+To install a theme, unpack your theme into your <tt>WindowMaker</tt> directory 
+(the same as old-style themes), usually <tt>~/GNUstep/Library/WindowMaker</tt>
+<br><br>
+<tt>cd ~/GNUstep/Library/WindowMaker</tt><br>
+<tt>gzip -dc "xyztheme.tar.gz" | tar xvf -</tt>
+<br><br>
+You can also do this in your system-wide <tt>WindowMaker</tt> directory (usually
+<tt>/usr/local/share/WindowMaker</tt>) to have the themes be available to all 
+your users. This will probably need to be done with root access.
+<br><br><br>
+
+
+<h2>How To Load a Theme</h2>
+ After installing a theme, it will automatically show up in your menu under <b>Appearance -> Themes -> ThemeName</b>.
+(unless of course you have manually changed your menu to remove this) If you have your Themes menu already opened and
+pinned to your desktop, you may need to close it and reopen it to have it show the new theme.
+<br><br>
+To manually load the new theme from the command line, use the <tt>setstyle</tt> command. Example:
+<br><br>
+<tt>setstyle xyztheme.themed</tt>
+<br><br>
+Note that if you move the directory of the theme (for example, from
+<tt>~/GNUstep/Library/WindowMaker/Themes</tt> to <tt>/usr/local/share/WindowMaker/Themes</tt>)
+you will have to reload that theme so that path information is updated.
+<br><br><br>
+
+
+<h2>How To Make a Theme Pack</h2>
+To create a theme pack from your current configuration, use the <tt>getstyle</tt>
+utility with the <tt>-p</tt> flag. Example:
+<br><br>
+<tt>getstyle -p ~/GNUstep/Library/WindowMaker/Themes/MyTheme</tt>
+<br><br>
+This will create a theme pack (a new directory in either the current
+directory or a directory you specify) named <tt>MyTheme.themed</tt>, containing
+everything it requires, including all pixmap files. In this example,
+the new theme pack would be made in your <tt>themes</tt> directory and be 
+immediately available in your "Themes" menu.
+<br><br>
+Additionally, you can put a text file named <tt>MyTheme.lsm</tt> in the <tt>MyTheme.themed</tt> 
+directory. This file can contain info like copyrights, credits or whatever.
+<br><br>
+To distribute your theme, just make a <tt>.tar.gz</tt> of the <tt>.themed</tt> directory.
+This is preferably done from the same directory that you unpack the themes
+from to maintain consistancy with the old theme format.
+<br><br>
+Example:
+<br><br>
+<tt>cd ~/GNUstep/Library/WindowMaker</tt><br>
+<tt>tar cvf MyTheme.tar Themes/MyTheme.themed</tt><br>
+<tt>gzip MyTheme.tar</tt>
+<br><br><br>
+
+
+<h2>How To Delete a Theme Pack</h2>
+Just remove the <tt>.themed</tt> directory. Example:
+<br><br>
+<tt>cd ~/GNUstep/Library/WindowMaker/Themes</tt><br>
+<tt>rm -fr themename.themed</tt>
+<br><br><br>
+
+
+<h2>How To Save Disk Space</h2>
+If you have more than 1 theme that use the same huge background image,
+you can delete all the duplicated files and then create hard links in
+place of them. For example, if you have:
+<br><br>
+<tt>theme1.themed/back.jpg</tt>
+<br><br>
+<tt>theme2.themed/backimage.jpg</tt>
+<br><br>
+<tt>theme3.themed/back.jpg</tt>
+<br><br>
+and all three files contain the same image, you can do:
+<br><br>
+<tt>rm theme2.themed/backimage.jpg</tt><br>
+<tt>rm theme3.themed/back.jpg</tt><br>
+<tt>ln theme1.themed/back.jpg theme2.themed/backimage.jpg</tt><br>
+<tt>ln theme1.themed/back.jpg theme3.themed/back.jpg</tt>
+<p/>
+<p/>
+&nbsp;
+
+      </td>
+      </tr>
+    </table>
+
+  <?php include("footer.php"); ?>
+
+</body>
+</html>