From: Doug Torrance Date: Sun, 13 Oct 2013 22:41:50 +0000 (-0500) Subject: Added theme pack documentation X-Git-Url: https://repo.or.cz/w/whome.git/commitdiff_plain/cde609df972a0565fb61de7e41f406aa2fbfd5bd Added theme pack documentation 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. --- diff --git a/FAQ.php b/FAQ.php index f6a82c0..4df3dc7 100644 --- 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. :)

-See the theme-HOWTO at http://largo.windowmaker.org/themes/themepacks.php -for an in-depth walk-through on making a Theme archive. +See the theme-HOWTO for an in-depth walk-through on making a Theme archive.

6.2  How do I install a theme?

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

6.4  How do I make a Theme?

-Please see the theme-HOWTO at http://largo.windowmaker.org/themes/themepacks.php -for details on making both new and old style themes (and the differences +Please see the theme-HOWTO 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 index 0000000..0d8b897 --- /dev/null +++ b/example-lsm.txt @@ -0,0 +1,7 @@ +Theme Name : Foobar +Author : Chuck Effbiesdee +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 index 0000000..8c38193 --- /dev/null +++ b/theme-HOWTO-dirs.php @@ -0,0 +1,36 @@ + + + + + Window Maker: Themes + + + + + + + + + + + + +
+
+
+ +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 + ~/GNUstep/Library/WindowMaker/Pixmaps for all tiles and menu/titlebar images, + ~/GNUstep/Library/WindowMaker/Icons for any icons you include + and ~/GNUstep/Library/WindowMaker/Backgrounds for your backgrounds. +

+ + +
+ + + + + diff --git a/theme-HOWTO-gifs.php b/theme-HOWTO-gifs.php new file mode 100644 index 0000000..a86a329 --- /dev/null +++ b/theme-HOWTO-gifs.php @@ -0,0 +1,41 @@ + + + + + Window Maker: Themes + + + + + + + + + + + + +
+
+
+ + 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 huge gif file, generally in the 1meg+ range.
+ The same file as a .jpg could be as much as 95% smaller or more!
+ (also see here for another good + reason not to use GIFs), +

+ 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. + See here for an example readme.lsm file. +

+ + +
+ + + + + diff --git a/theme-HOWTO-tar.php b/theme-HOWTO-tar.php new file mode 100644 index 0000000..88a9817 --- /dev/null +++ b/theme-HOWTO-tar.php @@ -0,0 +1,63 @@ + + + + + Window Maker: Themes + + + + + + + + + + + + +
+
+
+ + + Here's a quick guide to tar'ing your theme up:
+ cd to your ~/GNUstep/Library/WindowMaker/ directory, and type something like + the following: (replacing the file names appropriately for your theme) + +

+ +

    +
  1. tar -cvf Foo.tar Foo.lsm Backgrounds/FooBG.jpg Pixmaps/FooTile.xpm + Icons/FooIcon.xpm Themes/Foo +

    +
  2. gzip -9 Foo.tar +

    +
+ + This should leave you with a nice new Foo.tar.gz theme which includes (in this case), + the theme file (Themes/Foo), the background wallpaper (Backgrounds/FooBG.jpg), + a tile (Pixmaps/FooTile.xpm), an icon for the dock (Icons/FooIcon.xpm) + and a readme file (Foo.lsm).
+ LSM files for your themes are a must. The format of the LSM file is + easy. Click here for an example. +

+ If you're having trouble, try typing 'man tar' or ask for help on irc + in the #WindowMaker channel on EFnet. If all else fails, you can + contact us and we'll try and help you out, + but please try the other methods first. Thanks. +

+ Also, your theme file should NOT include your ~/GNUstep/Defaults/WindowMaker + 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 menu file or anything from your + ~/GNUstep/Defaults/ directory. ONLY include files from the directories + listed above and the readme.lsm file. + + +

+ + + + + diff --git a/theme-HOWTO.php b/theme-HOWTO.php new file mode 100644 index 0000000..e3d78a3 --- /dev/null +++ b/theme-HOWTO.php @@ -0,0 +1,71 @@ + + + + + Window Maker: Themes + + + + + + + + + + + + +
+
+
+ +

Theme HOWTO

+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 new ThemePack format!!! + +

+ +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 here +for info on the new ThemePack format. + +

+Have fun!
+ + + +-Largo + +

+ +
+ +
    +
  • + tar up your theme so that if the user untars it while in his/her + ~/GNUstep/Library/WindowMaker...the theme will instantly appear in their menu. + Here's a quick guide to tar'ing your theme up. +

    + +
  • Please use only Window Maker standard directory sructures. details +

    + +
  • + Please use jpeg's as your background images. details +

    + +
+ +All set! Now you can share it with your friends. :)
+If you have any further questions, or comments on possible additions to this HOWTO, please +let us know. Thanks! + + +
+ + + + + diff --git a/themepacks.php b/themepacks.php new file mode 100644 index 0000000..a46426d --- /dev/null +++ b/themepacks.php @@ -0,0 +1,124 @@ + + + + + Window Maker: Themes + + + + + + + + + + + + +
+
+
+ + +

ThemePacks HOWTO

+ +

Themes (Theme Packs) For Window Maker

+ +Note: the information contained in this file is only valid for themes +in the .themed (for theme directory) format, supported in +Window Maker 0.50.0 or newer. See here for +information on themes for WindowMaker-0.20.3 and earlier. +


+ + +

How To Install a Theme Pack

+ +To install a theme, unpack your theme into your WindowMaker directory +(the same as old-style themes), usually ~/GNUstep/Library/WindowMaker +

+cd ~/GNUstep/Library/WindowMaker
+gzip -dc "xyztheme.tar.gz" | tar xvf - +

+You can also do this in your system-wide WindowMaker directory (usually +/usr/local/share/WindowMaker) to have the themes be available to all +your users. This will probably need to be done with root access. +


+ + +

How To Load a Theme

+ After installing a theme, it will automatically show up in your menu under Appearance -> Themes -> ThemeName. +(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. +

+To manually load the new theme from the command line, use the setstyle command. Example: +

+setstyle xyztheme.themed +

+Note that if you move the directory of the theme (for example, from +~/GNUstep/Library/WindowMaker/Themes to /usr/local/share/WindowMaker/Themes) +you will have to reload that theme so that path information is updated. +


+ + +

How To Make a Theme Pack

+To create a theme pack from your current configuration, use the getstyle +utility with the -p flag. Example: +

+getstyle -p ~/GNUstep/Library/WindowMaker/Themes/MyTheme +

+This will create a theme pack (a new directory in either the current +directory or a directory you specify) named MyTheme.themed, containing +everything it requires, including all pixmap files. In this example, +the new theme pack would be made in your themes directory and be +immediately available in your "Themes" menu. +

+Additionally, you can put a text file named MyTheme.lsm in the MyTheme.themed +directory. This file can contain info like copyrights, credits or whatever. +

+To distribute your theme, just make a .tar.gz of the .themed directory. +This is preferably done from the same directory that you unpack the themes +from to maintain consistancy with the old theme format. +

+Example: +

+cd ~/GNUstep/Library/WindowMaker
+tar cvf MyTheme.tar Themes/MyTheme.themed
+gzip MyTheme.tar +


+ + +

How To Delete a Theme Pack

+Just remove the .themed directory. Example: +

+cd ~/GNUstep/Library/WindowMaker/Themes
+rm -fr themename.themed +


+ + +

How To Save Disk Space

+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: +

+theme1.themed/back.jpg +

+theme2.themed/backimage.jpg +

+theme3.themed/back.jpg +

+and all three files contain the same image, you can do: +

+rm theme2.themed/backimage.jpg
+rm theme3.themed/back.jpg
+ln theme1.themed/back.jpg theme2.themed/backimage.jpg
+ln theme1.themed/back.jpg theme3.themed/back.jpg +

+

+  + +

+ + + + +