KBFX – an alternative to T-Menu
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

412 lines
11KB

  1. How to apply the Menu button
  2. ============================
  3. The menu button is starting point for the menu.
  4. It first has to be added to the panel.
  5. To add the KBFX Menu to the panel, proceed as following:
  6. Right-click on the panel, on which you want to place the KBFX button
  7. Select "Add Applet to panel" in the context menu
  8. Select "KBFX Spinx"
  9. A tooltip appears "KBFX Spinx Added"
  10. If you move your mouse over the button, a tooltip appears (turned off
  11. in the default configuration).
  12. If you want to, you can now remove the K-Menu button and move the KBFX
  13. to the desired place on the panel.
  14. To open the menu, just click on the button.
  15. How to create themes for KBFX 0.4.9.3
  16. =====================================
  17. So you want to create your own themes for KBFX 0.4.9.3?
  18. The guide is done in a simple manner and we hope that you will easily and
  19. simply create themes for KBFX 0.4.9.3. If you don't like something in this
  20. guide, please feel free to contact us at IRC on irc.freenode.org
  21. on channel #kbfx
  22. NOTE: - The values for Width and Height are only our suggested values.
  23. You can use whatever values you feel are appropriate for your theme.
  24. - If ANY of these images are missing KBFX will use the image with the
  25. same name from the "default" theme.
  26. - In order to be used by the Configurator and by KBFX, every theme for
  27. 0.4.9.3 MUST HAVE a file in it's folder named "version-2" !
  28. topbg.png
  29. ---------
  30. This is an image that is at the top of the menu.
  31. Width = 504px
  32. Height = 95px
  33. dudebox.png
  34. -----------
  35. This is the background image where your personal image is displayed.
  36. Width = 95px
  37. Height = 88px
  38. menu_top_image_person.png
  39. -------------------------
  40. This image is used for theme's default personal image.
  41. Width = 48 px
  42. Height = 48 px
  43. find.png
  44. --------
  45. This is a small image displayed in the search field.
  46. Width = 22px
  47. Height = 21px
  48. rhstile.png
  49. -----------
  50. This is normal image displayed in categories.
  51. Width = 132px
  52. Height = 23px
  53. rhshovertile.png
  54. ----------------
  55. This is a hover image for categories.Used as hover image for rhstile.png
  56. Width = 132px
  57. Height = 23px
  58. scrollnormal.png / scrollnormalbot.png
  59. --------------------------------------
  60. These images are used as top and bottom scrollbars.
  61. Width = 240px
  62. Height = 10px
  63. separator.png / indexseparator.png
  64. ----------------------------------
  65. These are the separator images which separate your different subcategories.
  66. Width = 240px
  67. Height = 27px
  68. tilenormal.png
  69. --------------
  70. This is the normal image where your applications are showed.
  71. Width = 240px
  72. Height = 46px
  73. tilehover.png
  74. -------------
  75. This is the hover image where your applications are showed.
  76. Width = 240px
  77. Height = 46px
  78. listboxbg.png
  79. -------------
  80. This is the background under the categories. It can be viewed on description
  81. on both sides of the menu.
  82. Width = 108px
  83. Height = 23px
  84. middleboxbg.png
  85. ---------------
  86. This is the background of the middle part of the menu.
  87. Width = 200px
  88. Height = 270px
  89. botbg.png
  90. ---------
  91. This is the background image at the bottom of the menu.
  92. Width = 504px
  93. Height = 38px
  94. lock.png
  95. --------
  96. This is the lock image.
  97. Width = 84px
  98. Height = 38px
  99. lockhover.png
  100. -------------
  101. This is the lock hover image.
  102. Width = 84px
  103. Height = 38px
  104. logout.png
  105. ----------
  106. This is the logout image.
  107. Width = 84px
  108. Height = 38px
  109. logouthover.png
  110. ---------------
  111. This is the logout hover image.
  112. Width = 84px
  113. Height = 38px
  114. mask.png
  115. --------
  116. This is deciding what size your menu will have when users install it
  117. and which will be the transparent parts of the menu (through the alpha
  118. mask of the png image). Of course the size can be controlled later by
  119. the configuration of KBFX.
  120. Width = 504px
  121. Height = 513px
  122. logo.png
  123. ---------
  124. logo.png is used as a theme's or author's logo shown in the Information box of
  125. the KBFX Configurator. You can put whatever image you want and it will be scaled
  126. to 100px width by 100px height.
  127. Width = up to 100 px
  128. Height = up to 100 px
  129. preview.png
  130. -----------
  131. preview.png should be a snapshot of the working KBFX theme. It is used in the
  132. configuration application in order the user to see what the theme will look like.
  133. Width = 170 px
  134. Height = 205 px
  135. normal.png / hover.png / pressed.png
  136. ------------------------------------
  137. These are the KBFX Buttons for the kicker panel that are used in the theme.
  138. Width and Height - as you like, but preferably Height not to be too much.
  139. More information can be found on:
  140. http://www.kbfx.net/staticpages/index.php?page=howto0493
  141. How to write theme's kbfxfontrc and kbfxlayoutrc files
  142. ======================================================
  143. Every theme MAY have two configuration files named:
  144. kbfxfontrc - configures the fonts properties that the theme uses
  145. kbfxlayoutrc - configures the layout of the theme, the KBFX button
  146. and some other properties of the theme
  147. If one or both of these files don't exist, KBFX internal configuration
  148. options will be used for fonts and layout.
  149. All the properties and values are separated between different Sections
  150. in the way showed below:
  151. [Section]
  152. property = value
  153. When you want to prepare a theme, have in mind that every change that you
  154. make in the "KBFX Configurator" is kept in files in your home KDE directory.
  155. Usually these files are here:
  156. ~/.trinity/share/apps/kbfx/themerc
  157. and are named:
  158. THEMENAME_layoutrc
  159. THEMENAME_fontrc
  160. So if you want to ship your theme settings from the "KBFX Configurator", the best
  161. thing to do is to use the buttons: "EXPORT KBFXFONTRC FILE" ("Fonts" section of the
  162. Configurator) and "EXPORT KBFXLAYOUTRC FILE" ("Layout section" of the Configurator)
  163. and put the exported files in your theme folder.
  164. NOTE: - Pay close attention to the case of the properties and Sections names
  165. because the configuration is CASE SENSITIVE!
  166. - The order of the sections in the file is not important!
  167. - Have in mind that the Layout of the theme also depends on the sizes of
  168. the images!
  169. File kbfxfontrc
  170. ---------------
  171. It's best the colors to be represented in RGB format.
  172. Font Properties should constrain to QFont class representation.
  173. The values bellow are the default ones:
  174. [Fonts]
  175. TooltipText=0,0,0
  176. TooltipTextFont=Arial,8,-1,5,50,0,0,0,0,0
  177. ApplicationText=0,0,0
  178. ApplicationTextFont=Arial,8,-1,5,50,0,0,0,0,0
  179. CommentText=128,125,0
  180. CommentTextFont=Arial,8,-1,5,50,0,0,0,0,0
  181. GroupText=0,0,0
  182. GroupTextFont=Arial,8,-1,5,50,0,0,0,0,0
  183. UserName=255,255,255
  184. UserNameFont=Arial,10,-1,5,75,0,0,0,0,0
  185. SeparatorColor=0,0,0
  186. SeparatorFont=Arial,8,-1,5,50,0,0,0,0,0
  187. PluginColor=0,0,0
  188. PluginFont=Arial,8,-1,5,50,0,0,0,0,0
  189. LineColor=255,220,125
  190. # This is if the font when you hover on an item will be bold
  191. HoverBold = false
  192. File kbfxlayoutrc
  193. -----------------
  194. The values bellow are the default ones:
  195. [KbfxButton]
  196. # Time in msec for which the button
  197. # to fade in/out
  198. FadeTime=75
  199. # The three properties below describe the
  200. # paths to the theme's buttons.
  201. # KBFX uses the normal.png/hover.png/pressed.png
  202. # that are in the theme's folder by default.
  203. # So we recommend NOT to use the below three
  204. # properties!
  205. Normal = KBFX Normal Button Full Path
  206. Hover = KBFX Hover Button Full Path
  207. Press = KBFX Pressed Button Full Path
  208. [TopBar]
  209. # Face Position X
  210. DudeX=-1
  211. # Face Position Y
  212. DudeY=-1
  213. # Face Box Height
  214. FaceH=64
  215. # Face Box Width
  216. FaceW=65
  217. # Face Box Position X
  218. FaceX=27
  219. # Face Box Position Y
  220. FaceY=8
  221. # User Name Position X
  222. UserNameX=130
  223. # User Name Position Y
  224. UserNameY=32
  225. # Hide User Name
  226. DisableUserName=false
  227. # Top Bar Height
  228. Height=95
  229. # THE PROPERTIES BELOW ARE NOT USED FOR NOW
  230. # Top Bar Width
  231. Width=504
  232. # Top Bar Position X
  233. X=0
  234. # Top Bar Position Y
  235. Y=0
  236. [BottomBar]
  237. # Bottom Bar Height
  238. Height=38
  239. # THE PROPERTIES BELOW ARE NOT USED FOR NOW
  240. # Bottom Bar Width
  241. Width=504
  242. # Bottom Bar Position X
  243. X=0
  244. # Bottom Bar Position Y
  245. Y=428
  246. [Scrollbars]
  247. # THIS SECTION IS NOT USED FOR NOW
  248. # Bottom Scroll Bar Position X
  249. ScrollBarBotX=108
  250. # Bottom Scroll Bar Position Y
  251. ScrollBarBotY=95
  252. # Top Scroll Bar Position X
  253. ScrollBarTopX=108
  254. # Top Scroll Bar Position Y
  255. ScrollBarTopY=95
  256. [ListBox]
  257. # List Box Position X
  258. X=0
  259. # List Box Position Y
  260. Y=95
  261. # List Box Width
  262. Width=132
  263. # THE PROPERTIES BELOW ARE NOT USED FOR NOW
  264. # List Box Height
  265. Height=275
  266. [SearchBox]
  267. # Search Box Height
  268. Height=22
  269. # Search Box Width
  270. Width=240
  271. # Search Box Position X
  272. X=130
  273. # Search Box Position Y
  274. Y=48
  275. [ItemView]
  276. # Item Position X
  277. X=132
  278. # Item Position Y
  279. Y=95
  280. # Item Width
  281. Width=240
  282. # THE PROPERTIES BELOW ARE NOT USED FOR NOW
  283. # Item Height
  284. Height=275
  285. [ItemProperties]
  286. # Comment Margin in Item
  287. CommentMargin=66
  288. # Icon Size in Item
  289. IconSize=32
  290. # No Comments in Item
  291. NoComments=false
  292. [ToolBar]
  293. # THIS SECTION IS NOT USED FOR NOW
  294. # Tool Bar Button Normal Size
  295. ButtonNormalSize=48
  296. # Tool Bar Button Pressed Size
  297. ButtonPressedSize=48
  298. [MainMenu]
  299. # Main Menu Height
  300. UserMenuHeight=513
  301. # Main Menu Width
  302. UserMenuWidth=504
  303. # Contracted Menues
  304. ContractedMenu=false
  305. File version-2
  306. --------------
  307. This file is obligatory to exist, though it can be empty.
  308. It is used to designate that the theme is in the new format and the
  309. properties that are in the file are used in the KBFX Configurator for
  310. showing the user some info about the theme.
  311. The values in this file cannot be overwritten by the KBFX Configurator.
  312. If existing, the file should contain information about the theme's version,
  313. author's name, author's email and a homepage for the theme.
  314. The unspecified fields are replaced with the string - "Not Specified".
  315. The values bellow are self explanatory and are just an example:
  316. [ThemeGeneral]
  317. ThemeVersion=0.51
  318. AuthorName=Nookie
  319. AuthorEmail=nookie@no_spam.org
  320. Homepage=http://www.kbfx.net
  321. How to create a ".kbfxtheme" file for 0.4.9.3
  322. =============================================
  323. The ".kbfxtheme" file is a simple archive file (.tar.gz or .tar.bz2) that should
  324. contain at least these elements:
  325. - one or more theme folders with all the necessary images/files inside. Have in mind
  326. that the name of the theme is the name of the folder.
  327. - in the theme(s) folder(s) there should be an image named preview.png that serves
  328. as a live preview of the look of the theme.
  329. - in the theme(s) folder(s) there should be a file named version-2
  330. - the extension of the archive should be ".kbfxtheme"
  331. You can create ".kbfxtheme" file following these instructions (there is
  332. an option in Konqueror's rightclick "Actions" menu for preparing KBFX Theme Package
  333. OR you can create the ".kbfxtheme" file manually as described bellow):
  334. - Create a folder with a name that is identical to the name you want for your theme.
  335. - Put the necessary images/files inside it (see the above instructions for the images part).
  336. - Create an archive of the folder (with ark/tar etc).
  337. - Rename the archive file to ".kbfxtheme" and you are ready.
  338. How to help us out
  339. ==================
  340. You can help us for the KBFX releases with the translation of the interface.
  341. For this purpose please download the kbfxconfigapp.pot file from SourceForge:
  342. http://sourceforge.net/project/showfiles.php?group_id=141258&package_id=210120 .
  343. Another way to get a .pot file is to use the command "make package-messages"
  344. just after the configuration of the compilation process is done.
  345. Then use KBabel (http://kbabel.kde.org/) or poEdit (http://www.poedit.org/) to make the translation.
  346. Next send the .po file to my mail - phobosk@mail.kbfx.net
  347. Thanks in advance for this help.