######### JWM Kit First Run  ###################################################

So you really want to keep your current JWM config, and somebody else "default"
is not going to work for you. Here's the info to rebuild your current config to
be compatible with JWM Kit.


################################################################################
#########  Important Tips   ####################################################

IMPORTANT!: Make a back up your config before making changes.

Tip 1:	Unless you really have a custom config you spent a lot of time on It
	would be wiser to choose one of the simpler options.
Tip 2:	Work on rebuilding your config as time permits by making a backup and 
	then using one of the simpler options (default, or repair) to get your
	system working with JWM Kit. You can revert back to your custom config
	when you finish rebuilding it.
Tip 3:	Instead of manualy editing your config, use JWM Kit to recreate your
	custom configuration. Start with JWM Kit's default config, and use
	JWM Kit to customize it.
Tip 4:	When you have completed rebuilding your config make a backup of it, or 
	even better use JWM Kit repair & restore and create a restore point.


#########  Tips/Info about JWM Kit's Repair & Restore   ########################
################################################################################


JWM Kit Repair & Restore (Repair button under "advanced") will scan your config
and give an error report providing feedback helpful in finding and repairing
the errors. Easy access is provided to the file(s) needing repair. To be clear,
Repair & Restore does not ensure compatible with JWM or JWM Kit.  It only ensure
your configuration is properly formed and free of syntax errors.

If you have a restore point It would be much easier to restore to a previous
state using a restore point than it would be to restructure your configuration.

Use the [ Repair ] button to access JWM Kit Repair & Restore.


################################################################################
######### Restructure ##########################################################


Editing JWM's config require you to understand JWM's XML structure. 
You can learn more here under documentation: http://joewing.net/projects/jwm/


Q: Why restructure the configuration?
A: JWM Kit requires a more structured configuration than required by JWM. A
single file config maybe fine for JWM, but JWM Kit needs the file divided into
multiple parts. There are many benifits to having the file divided into many
parts, but I'll not bore you with the details.


The 2 step process.
1. The .jwmrc file should be divided into multiple files.
2. Create a jwmkit settings file. This file uses identifiers to help JWM Kit.
   A Template is provided at bottom of this file to aid in creating the file.


######### Step 1 ###############################################################
######### Creating/Editing the JWM Configuration ###############################


General note: 
	All files should start and end with the JWM Tag <JWM> and </JWM>
	Recommend: Filenames represents the files purpose. Example: icons, keys.
	Complete path of .jwmrc file is $HOME/.jwmrc  ($HOME = user's home)
	Recommend path for the remaining files is $HOME/.config/jwm/
	Files should not be stored outside of the user's home.

Themes: Theme are handled by JWM Kit Appearance.
	The theme is defined in the file $HOME/.config/jwm/theme as an <Include>
	The file $HOME/.config/jwm/theme should be included in .jwmrc
	Themes should be stored in: $HOME/.config/jwm/themes/

Button sets: Button sets are handled by JWM Kit Appearance.
	The Selected button set is defined in the settings file and is
	automatically added/removed to the .jwmrc as needed. 
	The buttons config is auto generated.
	Buttons set should be store in: /home/riot/.config/jwm/themes/buttons

Note:	If one of the file in the list below is not presently needed,
	create a file with only the JWM Tags: <JWM></JWM>, save it, and add it to
	.jwmrc and the jwmkit settings file. This will help JWM Kit if the file is
	needed in the future. 

Essential files: The .jwmrc file, a file for each tray, a file for each menu and
		 a file for groups, icons, keys, preferences, startup, and theme
		 Note:	All of these file must be included in the .jwmrc, and the
			JWM Kit setting file

## Specification of each file ##

.jwmrc: should only have <Include> tags. Ensure every Essential file is included.

tray:	You need 1 tray file for each tray. If you have 3 trays, you need 3 files. 
	Only uses the Tray tag and tags supported within the Tray tag

menu:	You need 1 menu file for each menu. If you have 3 menus, you need 3 files. 
	Only use the RootMenu tag and tags supported within the RootMenu tag

groups:	As many group entries as needed. 
	Only use the Group tags and tags supported with in the Group tag.

icons:	As many IconPath entries as needed. 
	Only use the IconPath tag.

keys:	As many Key entries as needed. 
	Supports the Key and Mouse tags

theme:	Only a single <Include> for the path to the currently selected theme

themes: Do NOT Include in the .jwmrc. or to the JWM Kit settings file.
	instead add to the theme file mentioned above.
	Tags that control Visual Style
	Only use these tags and tags supported within them: 
	WindowStyle, ClockStyle, TrayStyle, TaskListStyle, TrayButtonStyle,
	PagerStyle,MenuStyle, PopupStyle

startup: Only use the StartupCommand, RestartCommand, and ShutdownCommand tags

preferences:	Only the following Tags and tags supported within them:
	 	Desktop ,DoubleClickSpeed, DoubleClickDelta,
		FocusModel, MoveMode, ResizeMode, SnapMode, TitleButtonOrder


######### Step 2 ###############################################################
######### Creating/Editing the settings file ###################################


Copy and paste the template below into to a text editor.
Note:	Leave nothing out. Include every line below, just change the file paths.
Hint:	Missing file? Just create an empty file containing <JWM></JWM>

Replace the 'example' paths in the templete with the real path of your files.
Note:	Do not add tray and menu files to the setting file
Note:	Replace the path to your home folder with $HOME.
	example: /home/user/.config/jwm/icons  --->  $HOME/.config/jwm/icons

Leave a blank line at the end of the file. (Should be the only blank line)
Save the file as settings in the directory $HOME/.config/jwmkit/ 
(complete path: $HOME/.config/jwmkit/settings)

#------ templete for the settings file ------#

icons=$HOME/.config/jwm/icons
startup=$HOME/.config/jwm/startup
preferences=$HOME/.config/jwm/preferences
groups=$HOME/.config/jwm/groups
keys=$HOME/.config/jwm/keys
theme=$HOME/.config/jwm/theme

#--------------------------------------------#


######### DONE? ################################################################
######### Verify & Test the configuration ######################################

You can use JWM Kit Repair & Restore to test your configuration.  You can also
Run jwm -p in the terminal to test the config. Both methods will find any errors
and report them.

* Note: I have seen jwm falsely report errors when a part of the configuration
	was produced dynamically by an executable/script. For example an
	include with exec: or a dynamic menu using exec:
	As long as things works correctly you can ignore such an error.

	
######### Verify & Test the configuration ######################################

JWM Kit's Repair & Restore will scan your config and give an error report
providing feedback helpful in finding and repairing the errors.
Easy access is provided to the file(s) needing repair.

When done, test your configuration by restarting JWM with the button on this
app, or run jwm -restart in terminal. 

If you have properly edited the JWM config to meet the requirments JWM and
JWM Kit should both be working correctly.  Try various JWM Kit apps to see
if all works well. If any part of JWM Kit does not work correctly double
check that each file meets the requirments above.

If you are unsuccessful, you can alway use the default config and customize
it to your liking.

Final word of advice. When you are happy with your confg use JWM Kit Repair & 
Restore to create a restore point.

################################################################################
