void-packages/srcpkgs/obmenu-generator/files/README.void

README.void

 To properly use obmenu-generator in void linux you have to tweak
 two files:

 A config file, auto generated by obmenu-generator: 

   ~/.config/obmenu-generator/config.pl 

  
 The Schema file that you have to copy from:

 /etc/xdg/obmenu-generator/schema.pl 

 in:

  ~/.config/obmenu-generator/schema.pl  


 Both files are well documentend into the code.

 Read also the comments in the code of

 /usr/bin/obmenu-generator 

 (it's a perl script) for more advanced use.

 Modify ~/.config/obmenu-generator/schema.pl  according to your 
 needs to adapt the categories names to your language after theese lines 

 {sep => "desidered name of the submenu"}, (see below for the default).

 <begin code extract>
   {sep => 'Applications'},   

   #          NAME            LABEL                ICON
   {cat => ['utility',     'Accessories', 'applications-utilities']},
   {cat => ['development', 'Development', 'applications-development']}, 
 <end code extract>
  
 The LABEL column is the place where you localize the names.
 
 If you want to use a schema to provide only an application submenu, in
 the doc dir you will find tje file "schema.pl.app" already tailored for
 this use.

 The config.pl is created by obmenu-generator but you may want to customize
 the language of the auto generated names, for that you have to modify a line
 near the end, modifying the "name_keys" key to read as follow (substituing
 the [it] to your preferred language code).

   "name_keys"           => ['Name[it]', 'GenericName[it]', 'Name'],

 Accordig to the criptic comment in the script the modifications you have done
 do in the config.pl may be overridden by the program itself, so be prepared
 to rewrite every line you modify in the config.pl file from time to time
 (it is better to copy the config.pl in the ~/.config/obmenu-generator dir 
 config.pl.mine as a backup copy when you have done the personalisations).
 
 After you have done all your modification, insert this line in your Openbox
 menu.xml where you want the menu will be:
 
  <menu id="obmenu-generator" label="<Your Menu Name>" execute="/usr/bin/obmenu-generator -i"/>

 Then do openbox -reconfigure (or use the menu entry that usually come with
 openbox) and enjoy your new application menu.

 The script is very powerful and has many other use even to autogenerate a 
 menu.xml, read the documentation and better the comments that are more up to
 date at: 
 
 http://trizenx.blogspot.ro/2012/02/obmenu-generator.html

 Happy obmenu-generator!

 The Void Mantainers