Difference between revisions of "Customizing"

From Mibbit Wiki
Jump to: navigation, search
m (links to Dset...)
m (Is this page needed/wanted?)
 
(11 intermediate revisions by 5 users not shown)
Line 1: Line 1:
For more recent versions and examples see [[Uri_parameters]] and [[Dset]]
+
Some '''customizing''' (server, channels...) is done via [[Uri parameters]], others (colors, fonts, chat output ...) by storing your [[Prefs|preferences]] in [[Skins]].
  
==startup parameters==
 
<table border=1 cellpadding=2 style="border-collapse:collapse">
 
<tr><th colspan=4>uri query string only</th></tr>
 
  
<tr><th>option</th><th>full version (default)</th><th>widget (default)</th><th>example / comment</th></tr>
+
== Adding a background image. ==
  
<tr><td>server</td><td>irc.mibbit.com</td><td>irc.mibbit.com</td><td> used by default</td></tr>
+
In the Prefs tab, there are various ways to customise your widget. One of which, is replacing the solid colour background with an image of your choice. For a working example of this, please refer to [[Skins#Nice_Textures|Skins]]
<tr><td>channel</td><td>#mibbit</td><td>#chat</td><td>comma separated channel list like %23chat,%23foo%20key4foo</td></tr>
 
<tr><td>nick</td><td>mib_[random_part]</td><td>mib_[random_part]</td><td></td></tr>
 
  
<tr><td>forcePrompt</td><td>NA</td><td>false</td><td>false works only on approved servers and irc.mibbit.com</td></tr>
+
As an example, you can change the chat background of your widget to suit your website. For this, you would open the [[Prefs]] tab, and then click on "Chat Out".
<tr><td>promptPass</td><td>NA</td><td>false</td><td>NickServ auth only at the moment</td></tr>
 
<tr><td>authkey</td><td>NA</td><td>empty</td><td>see [[Widget#Securing_your_widget]]</td></tr>
 
<tr><td>noServerTab</td><td>NA</td><td>true</td><td></td></tr>
 
<tr><td>noServerNotices</td><td>NA</td><td>false</td><td></td></tr>
 
<tr><td>noServerMotd</td><td>NA</td><td>false</td><td></td></tr>
 
<tr><td>customprompt</td><td>NA</td><td>empty</td><td>Welcome%20To%20MyChat</td></tr>
 
<tr><td>customloading</td><td>NA</td><td>empty</td><td>be%20patient...</td></tr>
 
<tr><td>charset</td>      <td>(account)</td><td>empty</td><td>default (and recommended): UTF-8</td></tr>
 
<tr><td>settings</td>    <td>(prefs: id=...)</td><td>empty</td><td>from a mibbit full account: "prefs"</td></tr>
 
<tr><td>url</td><td>empty</td><td>NA</td><td><nowiki>url=<urlencoded irc://server/#channel></nowiki>, see [[Uri_parameters]]</td></tr>
 
</table>
 
  
Usage in the uri: ?firstOption=value&option2=value&option3=value ....  
+
Checking the Chat pane background field, you can see that the default setting of the widget is already a background image, albeit a small one.
  
(don't forget to replace all # with '''%23''' and all <space> with '''%20''' !)
+
[[Image:Customise img bkg.png|Highlighted Chat Pane Background]]
  
==Default preferences==
+
For any background field, you can either enter in a colour code, (eg: #ffffff for white), "transparent" for a transparent/white or a link to an image with url(http://url.goes.com/here.gif)
<table border=1 cellpadding=2 style="border-collapse:collapse">
 
<tr><th colspan=4>"/dset", 2008-06-10 , sorted</th></tr>
 
<tr><th>option</th><th>full version</th><th>widget</th><th>comment</th></tr>
 
  
<tr><td>allowIncommingPMs</td><td colspan=2>true</td><td></td></tr>
+
The url parameter supports any of the usual css options, such as repeat.
<tr><td>autoAway</td><td colspan=2>7200</td><td>0 = disable</td></tr>
+
[[Category:Widget]]
<tr><td>autoAwayMessage</td><td colspan=2>Auto away</td><td></td></tr>
 
<tr><td>autoBack</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>blurPMs</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>cgmMargins</td><td colspan=2>3</td><td></td></tr>
 
 
 
<tr><td>chatBackground</td><td colspan=2>white</td><td></td></tr>
 
<tr><td>chatBackgroundLines</td><td colspan=2>#c8c8ff</td><td></td></tr>
 
 
 
<tr><td>chatFontFamily</td><td colspan=2>Arial,Helvetica,sans-serif</td><td></td></tr>
 
<tr><td>chatFontSize</td><td colspan=2>13</td><td></td></tr>
 
 
 
<tr><td>chatInputBackground</td><td colspan=2>#eee</td><td></td></tr>
 
<tr><td>chatInputBarBackground</td><td colspan=2>#cad69f</td><td></td></tr>
 
<tr><td>chatInputBarBorder</td><td colspan=2>#51661c</td><td></td></tr>
 
<tr><td>chatInputBorder</td><td colspan=2>#cad69f</td><td></td></tr>
 
<tr><td>chatInputColor</td><td colspan=2>black</td><td></td></tr>
 
<tr><td>chatInputFontFamily</td><td colspan=2>Arial,Helvetica,sans-serif</td><td></td></tr>
 
<tr><td>chatInputOptionsBackground</td><td colspan=2>transparent</td><td></td></tr>
 
 
 
<tr><td>chatOutputBackground</td><td colspan=2>transparent</td><td></td></tr>
 
<tr><td>chatOutputMaxLines</td><td colspan=2>250</td><td></td></tr>
 
<tr><td>chatOutputNickWidth</td><td>90</td><th>110</th><td></td></tr>
 
<tr><td>chatOutputShowTimes</td><td>true</td><th>false</th><td></td></tr>
 
<tr><td>chatOutputTimeWidth</td><td colspan=2>30</td><td></td></tr>
 
 
 
<tr><td>chatPaddingBottom</td><td colspan=2>1</td><td></td></tr>
 
<tr><td>chatPaddingTop</td><td colspan=2>1</td><td></td></tr>
 
<tr><td>chatPaneBackground</td><td colspan=2>white</td><td></td></tr>
 
<tr><td>chatPaneBorder</td><td colspan=2>#51661c</td><td></td></tr>
 
 
 
<tr><td>colorAway</td><td colspan=2>#c66</td><td></td></tr>
 
<tr><td>colorBack</td><td colspan=2>#6c6</td><td></td></tr>
 
<tr><td>colorBan</td><td colspan=2>#22c</td><td></td></tr>
 
<tr><td>colorChangeNick</td><td colspan=2>#880</td><td></td></tr>
 
<tr><td>colorChannels</td><td colspan=2>green</td><td></td></tr>
 
<tr><td>colorChat</td><td colspan=2>#000</td><td></td></tr>
 
<tr><td>colorChatMe</td><td colspan=2>#000</td><td></td></tr>
 
<tr><td>colorChatRecent</td><td colspan=2>#888</td><td></td></tr>
 
<tr><td>colorEmote</td><td colspan=2>#c44</td><td></td></tr>
 
<tr><td>colorEmoteMe</td><td colspan=2>#c44</td><td></td></tr>
 
<tr><td>colorEmoteRecent</td><td colspan=2>#e88</td><td></td></tr>
 
<tr><td>colorInvite</td><td colspan=2>#66c</td><td></td></tr>
 
<tr><td>colorIRCLinks</td><td colspan=2>red</td><td></td></tr>
 
<tr><td>colorJoin</td><td colspan=2>#0f0</td><td></td></tr>
 
<tr><td>colorKick</td><td colspan=2>#f00</td><td></td></tr>
 
<tr><td>colorLinks</td><td colspan=2>blue</td><td></td></tr>
 
<tr><td>colorNotice</td><td colspan=2>#800</td><td></td></tr>
 
<tr><td>colorPart</td><td colspan=2>#f00</td><td></td></tr>
 
<tr><td>colorSystem</td><td colspan=2>#800</td><td></td></tr>
 
<tr><td>colorTopic</td><td colspan=2>#008</td><td></td></tr>
 
<tr><td>colorTopicWho</td><td colspan=2>#088</td><td></td></tr>
 
<tr><td>colorUserMode</td><td colspan=2>#662</td><td></td></tr>
 
 
 
<tr><td>confirmServerClose</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>doubleClickTime</td><td colspan=2>400</td><td></td></tr>
 
<tr><td>doubleClickToPM</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>focusNewJoins</td><td>true</td><th>false</th><td></td></tr>
 
<tr><td>inputHistorySize</td><td colspan=2>250</td><td></td></tr>
 
<tr><td>language</td><td colspan=2>en</td><td>used for the UI</td></tr>
 
<tr><td>logPMs</td><td colspan=2>false</td><td></td></tr>
 
<tr><td>needSendButton</td><td colspan=2>false</td><td></td></tr>
 
 
 
<tr><td>nickBackground</td><td colspan=2>#cad69f</td><td></td></tr>
 
<tr><td>nickColor</td><td colspan=2>green</td><td></td></tr>
 
<tr><td>nickColorMe</td><td colspan=2>#242</td><td></td></tr>
 
<tr><td>nickFontFamily</td><td colspan=2>Arial,Helvetica,sans-serif</td><td></td></tr>
 
<tr><td>nickFontSize</td><td colspan=2>11</td><td></td></tr>
 
<tr><td>nickHighlight</td><td colspan=2>#686</td><td></td></tr>
 
<tr><td>nickHighlightMe</td><td colspan=2>#4a4</td><td></td></tr>
 
 
 
<tr><td>noticesToActiveTab</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>noUListInChannels</td><td colspan=2>false</td><td></td></tr>
 
 
 
<tr><td>parseChannels</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>parseColor</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>parseLinks</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>parseNicks</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>parseReplaceImages</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>parseReplaceImagesHeight</td><td colspan=2>32</td><td></td></tr>
 
<tr><td>parseReplaceImagesWidth</td><td colspan=2>32</td><td></td></tr>
 
<tr><td>parseSimple</td><td colspan=2>true</td><td>*bold* /itallic/ _underlined_</td></tr>
 
<tr><td>parseSmilies</td><td colspan=2>true</td><td></td></tr>
 
 
 
<tr><td>sendButtonBackground</td><td colspan=2>white</td><td></td></tr>
 
<tr><td>sendButtonBorder</td><td colspan=2>#448
 
 
 
<tr><td>showAwaysBacks</td><td>true</td><th>false</th><td></td></tr>
 
<tr><td>showBans</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>showInputOptions</td><td colspan=2>true</td><td></td></tr>
 
<tr><td>showJoinInfo</td><td colspan=2>false</td><td></td></tr>
 
<tr><td>showJoinsParts</td><td>true</td><th>false</th><td></td></tr>
 
<tr><td>showPartInfo</td><td colspan=2>false</td><td></td></tr>
 
<tr><td>showUserModes</td><td colspan=2>true</td><td></td></tr>
 
 
 
<tr><td>tabBackgroundColor</td><td colspan=2>#000</td><td></td></tr>
 
 
 
<tr><td>tabBColorCannel</td> <td colspan=2>#ccc</td><td>B)order</td></tr>
 
<tr><td>tabBColorPM</td>    <td colspan=2>#ccc</td><td></td></tr>
 
<tr><td>tabBColorServer</td> <td colspan=2>#c0ffc0</td><td></td></tr>
 
<tr><td>tabBColorYServer</td><td colspan=2>#c0c0f3</td><td></td></tr>
 
 
 
<tr><td>tabColorCannel</td>  <td colspan=2>#e6f3ca</td><td></td></tr>
 
<tr><td>tabColorPM</td>      <td colspan=2>#8c8c8c</td><td></td></tr>
 
<tr><td>tabColorServer</td>  <td colspan=2>#6cb12a</td><td></td></tr>
 
<tr><td>tabColorYServer</td> <td colspan=2>#c0c0f3</td><td></td></tr>
 
 
 
<tr><td>tabFontFamily</td><td colspan=2>Arial,Helvetica,sans-serif</td><td></td></tr>
 
<tr><td>tabSpacing</td><td colspan=2>4</td><td></td></tr>
 
 
 
<tr><td>tabTextColor</td><td colspan=2>#000</td><td></td></tr>
 
<tr><td>tabTextColorActivity</td><td colspan=2>#33c</td><td></td></tr>
 
<tr><td>tabTextColorActivityMe</td><td colspan=2>#c33</td><td></td></tr>
 
<tr><td>tabTextColorArrows</td><td colspan=2>#eee</td><td></td></tr>
 
<tr><td>tabTextColorInactive</td><td colspan=2>#444</td><td></td></tr>
 
 
 
<tr><td>timeBackground</td><td colspan=2>#e4eace</td><td></td></tr>
 
<tr><td>timeColor</td><td colspan=2>#444</td><td></td></tr>
 
<tr><td>timeFontFamily</td><td colspan=2>Arial,Helvetica,sans-serif</td><td></td></tr>
 
<tr><td>timeFontSize</td><td colspan=2>11</td><td></td></tr>
 
 
 
<tr><td>ulistPaneBackground</td><td colspan=2>white</td><td></td></tr>
 
<tr><td>ulistPaneBorder</td><td colspan=2>#51661c</td><td></td></tr>
 
 
 
<tr><td>userListColorInactive</td><td colspan=2>#6c6</td><td></td></tr>
 
<tr><td>userListColorNormal</td><td colspan=2>green</td><td></td></tr>
 
<tr><td>userListColorTyping</td><td colspan=2>red</td><td></td></tr>
 
 
 
<tr><td>userListFontFamily</td><td colspan=2>Arial,Helvetica,sans-serif</td><td></td></tr>
 
<tr><td>userListFontSize</td><td colspan=2>13</td><td></td></tr>
 
 
 
<tr><td>userListHover</td><td colspan=2>#d8d8d8</td><td></td></tr>
 
<tr><td>userListMenuBackground</td><td colspan=2>#cad69f</td><td></td></tr>
 
<tr><td>userListMenuColor</td><td colspan=2>#444</td><td></td></tr>
 
<tr><td>userListSelected</td><td colspan=2>#e4eace</td><td></td></tr>
 
<tr><td>userListWidth</td><td>140</td><th>130</th><td></td></tr>
 
 
 
<tr><td>windowAlertMaxFlashes</td><td colspan=2>3</td><td></td></tr>
 
<tr><td>windowAlertPeriod</td><td colspan=2>500</td><td></td></tr>
 
 
 
<tr><th>option</th><th>full version</th><th>widget</th><th>comment</th></tr>
 
</table>
 
use [Prefs] or /dset option value to change settings (sometimes you need /clear or even a reload to take effect).
 
 
 
Some of the options don't make much sense in the [[widget]] but are used as defaults.
 
 
 
(work in progress)
 

Latest revision as of 02:59, 26 April 2010

Some customizing (server, channels...) is done via Uri parameters, others (colors, fonts, chat output ...) by storing your preferences in Skins.


Adding a background image.

In the Prefs tab, there are various ways to customise your widget. One of which, is replacing the solid colour background with an image of your choice. For a working example of this, please refer to Skins

As an example, you can change the chat background of your widget to suit your website. For this, you would open the Prefs tab, and then click on "Chat Out".

Checking the Chat pane background field, you can see that the default setting of the widget is already a background image, albeit a small one.

Highlighted Chat Pane Background

For any background field, you can either enter in a colour code, (eg: #ffffff for white), "transparent" for a transparent/white or a link to an image with url(http://url.goes.com/here.gif)

The url parameter supports any of the usual css options, such as repeat.