From 48540940b6c28bb4378abfeb500ec45a625b37b6 Mon Sep 17 00:00:00 2001 From: Vadim Dashevskiy Date: Tue, 15 May 2012 10:38:20 +0000 Subject: initial commit git-svn-id: http://svn.miranda-ng.org/main/trunk@2 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c --- plugins/tipper/docs/autoexec_Tipper(Omniwolf).ini | 339 +++++++++++++++++++ plugins/tipper/docs/autoexec_Tipper(Tweety).ini | 379 ++++++++++++++++++++++ plugins/tipper/docs/licence_Tipper.txt | 6 + plugins/tipper/docs/m_tipper.h | 23 ++ plugins/tipper/docs/readme_tipper.txt | 144 ++++++++ 5 files changed, 891 insertions(+) create mode 100644 plugins/tipper/docs/autoexec_Tipper(Omniwolf).ini create mode 100644 plugins/tipper/docs/autoexec_Tipper(Tweety).ini create mode 100644 plugins/tipper/docs/licence_Tipper.txt create mode 100644 plugins/tipper/docs/m_tipper.h create mode 100644 plugins/tipper/docs/readme_tipper.txt (limited to 'plugins/tipper/docs') diff --git a/plugins/tipper/docs/autoexec_Tipper(Omniwolf).ini b/plugins/tipper/docs/autoexec_Tipper(Omniwolf).ini new file mode 100644 index 0000000000..b68bdc8d75 --- /dev/null +++ b/plugins/tipper/docs/autoexec_Tipper(Omniwolf).ini @@ -0,0 +1,339 @@ +SETTINGS: + +[Tipper] +WinWidth=d400 +WinMaxHeight=d400 +Transparency=b19 +Border=b0 +RoundCorners=b1 +Animate=b0 +TransparentBg=b0 +RightIcon=b0 +AVLayout=b2 +AVSize=d86 +TextIndent=d22 +ShowNoFocus=b1 +DSNumValues=w19 +DINumValues=w22 +ShowStatusMsg=b1 +Type0=b1 +TransFunc0=w7 +DIValue0=u%Status% +DILineAbove0=b0 +DIValNewline0=b0 +Type1=b1 +TransFunc1=w7 +DILineAbove1=b0 +DIValNewline1=b0 +Type2=b1 +TransFunc2=w2 +DILineAbove2=b0 +DIValNewline2=b0 +Type3=b1 +TransFunc3=w3 +Type4=b1 +TransFunc4=w1 +DILineAbove3=b0 +DIValNewline3=b0 +Type5=b1 +TransFunc5=w1 +DILineAbove4=b1 +DIValNewline4=b0 +Type6=b1 +TransFunc6=w1 +DILineAbove5=b0 +DIValNewline5=b0 +DILabel0=uStatus: +Type7=b1 +TransFunc7=w1 +DILineAbove6=b0 +DIValNewline6=b0 +Name8=umetaS0 +Type8=b1 +TransFunc8=w1 +Name9=umetaS1 +Type9=b1 +TransFunc9=w1 +Name10=umetaS2 +Type10=b1 +TransFunc10=w1 +Name11=umetaS3 +Type11=b1 +TransFunc11=w1 +Name12=umetaS4 +Type12=b1 +TransFunc12=w1 +Name13=umetaS5 +Type13=b1 +TransFunc13=w1 +Type14=b1 +TransFunc14=w1 +Type15=b1 +TransFunc15=w1 +Type16=b1 +TransFunc16=w1 +DILineAbove7=b0 +DIValNewline7=b0 +DILineAbove8=b1 +DIValNewline8=b0 +DILineAbove9=b1 +DIValNewline9=b0 +DILineAbove10=b1 +DIValNewline10=b1 +Name14=umetaS6 +Name16=umetaS8 +Type17=b1 +TransFunc17=w1 +Name15=umetaS7 +Name17=umetaS9 +Type18=b1 +TransFunc18=w1 +Type19=b1 +TransFunc19=w0 +Type20=b1 +TransFunc20=w0 +FontFirstSize=b241 +FontFirstSty=b1 +FontFirstSet=b0 +FontFirstCol=d255 +FontLabelsSize=b243 +FontLabelsSty=b0 +FontLabelsSet=b0 +FontLabelsCol=d4210752 +FontValuesSize=b243 +FontValuesSty=b0 +FontValuesSet=b0 +FontValuesCol=d0 +ColourBg=d14476004 +Name0=uicqIP +Name18=uStatus +Type21=b1 +TransFunc21=w1 +DILineAbove11=b1 +DIValNewline11=b1 +Name1=uicqIPreal +Name19=uMirVer +Name20=usametimeID +Name21=uStatus +Name22=uUIN +Type22=b1 +TransFunc22=w0 +DILineAbove12=b1 +DIValNewline12=b0 +RightLabels=b0 +TimeIn=w500 +DILineAbove17=b0 +DIValNewline17=b0 +DILineAbove18=b0 +DIValNewline18=b0 +DILineAbove19=b0 +DIValNewline19=b0 +DILineAbove20=b0 +DIValNewline20=b0 +DILineAbove21=b0 +DIValNewline21=b0 +DILineAbove13=b0 +DIValNewline13=b0 +DILineAbove14=b0 +DIValNewline14=b0 +DILineAbove15=b0 +DIValNewline15=b0 +DILineAbove16=b0 +DIValNewline16=b0 +DILineAbove22=b1 +DIValNewline22=b0 +Module0=s +Setting0=sIP +Module1=s +Setting1=sRealIP +Module2=s +Setting2=sIdleTS +Module3=s +Setting3=sIdleTS +Module4=s +Module5=s +Module6=s +Module7=s +Module8=s +Module9=s +Module10=s +Module11=s +Module12=s +Module13=s +Module14=s +Module15=s +Module16=s +Setting16=sStatus8 +Module17=s +Setting17=sStatus9 +Module18=s +Module19=s +Setting19=sMirVer +Module20=s +Setting20=sstid +Module21=s +Setting21=sStatus +Module22=s +Setting22=sUIN +BorderCol=d0 +Name3=uIdleTS-diff +Setting7=sLogonTS +Setting8=sStatus0 +Setting9=sStatus1 +Setting10=sStatus2 +Setting11=sStatus3 +Setting12=sStatus4 +Setting13=sStatus5 +DILineAbove23=b0 +DIValNewline23=b0 +DILineAbove24=b0 +DIValNewline24=b0 +DILineAbove25=b0 +DIValNewline25=b0 +DILineAbove26=b0 +DIValNewline26=b0 +DILineAbove27=b0 +DIValNewline27=b0 +DILineAbove28=b0 +DIValNewline28=b0 +TitleLayout=b0 +Padding=w4 +Position=b1 +MinWidth=d0 +MinHeight=d0 +WORD to status description=d1 +NextFuncId=d17 +DWORD timestamp to time=d2 +DWORD timestamp to time difference=d3 +BYTE to Yes/No=d4 +BYTE to Male/Female (ICQ)=d5 +WORD to country name=d6 +DWORD to ip address=d7 +Day|Month|Year to date=d8 +Day|Month|Year to age=d9 +Hours|Minutes|Seconds to time=d10 +Day|Month|Year|Hours|Minutes|Seconds to time difference=d11 +DWORD timestamp to time (no seconds)=d12 +Hours|Minutes to time=d13 +DWORD timestamp to date (short)=d14 +DWORD timestamp to date (long)=d15 +MaxWidth=d350 +MaxHeight=d400 +Opacity=b85 +TransFuncId0=d7 +TransFuncId1=d7 +TransFuncId2=d14 +TransFuncId3=d3 +TransFuncId4=d12 +TransFuncId5=d14 +TransFuncId6=d3 +TransFuncId7=d12 +TransFuncId8=d1 +TransFuncId9=d1 +TransFuncId10=d1 +TransFuncId11=d1 +TransFuncId12=d1 +TransFuncId13=d1 +TransFuncId14=d1 +MouseTollerance=b16 +DropShadow=b1 +DILineAbove29=b0 +DIValNewline29=b0 +RightValues=b0 +SBarTips=b1 +xStatus: empty xStatus name to default name=d16 +DILineAbove30=b0 +DIValNewline30=b0 +DividerCol=d8421440 +SidebarCol=d9741995 +AvatarRoundCorners=b0 +AvatarPadding=w7 +TextPadding=w4 +SidebarWidth=d22 +Name2=uIdleTS-date +Name4=uIdleTS-time +Setting4=sIdleTS +Setting14=sStatus6 +TransFuncId15=d1 +Name5=uLogonTS-date +Name6=uLogonTS-diff +Name7=uLogonTS-time +Setting15=sStatus7 +TransFuncId16=d1 +TransFuncId17=d1 +Setting18=sStatus +TransFuncId18=d1 +Setting5=sLogonTS +Setting6=sLogonTS +FontValues=uTahoma +FontLabels=uTahoma +FontFirst=uTahoma +DILabel26=uHigh/Low: +DILabel27=uPressure: +DILabel1=uName: +DIValue1=u%raw:/FirstName|% %raw:/LastName% +DIValue3=u%raw:/MirVer% +DILabel6=uExternal IP: +DILabel23=uVisibility: +DILabel28=uHumidity: +DILabel7=uInternal IP: +DILabel8=uActive subcontact: +DIValue8=u%sys:meta_subproto% - %sys:meta_subname% +DILabel22=uObservation time: +DIValue22=u%raw:Current/Update% +DIValue23=u%raw:Current/Visibility% +DILabel24=uFeels like: +DIValue24=u%raw:Current/Feel% +DILabel25=uWind: +DIValue25=u%raw:Current/Wind Direction% (%raw:Current/Wind Direction DEG%)/%raw:Current/Wind Speed% +DIValue26=u%raw:Current/High%/%raw:Current/Low% +DIValue27=u%raw:Current/Pressure% (%raw:Current/Pressure Tendency%) +DIValue28=u%raw:Current/Humidity% +DILabel29=uUV Index: +DIValue29=u%raw:Current/UV% - %raw:Current/UVI% +DILabel30=uSunrise/Sunset: +DIValue30=u%raw:Current/Sunrise%/%raw:Current/Sunset% +DILabel31=uMoonphase +DIValue31=u%raw:Current/Moon% +DILineAbove31=b0 +DIValNewline31=b0 +DIValue6=u%icqIP% +DIValue7=u%icqIPreal% +DILabel2=u%sys:uidname^!MetaContacts%: +DIValue2=u%sys:uid% +DILabel3=uClient: +DILabel4=uLogged on: +DIValue4=u%LogonTS-diff% +DILabel5=uIdle: +DIValue5=u%IdleTS-diff% +FontFirstFlags=d288 +FontLabelsFlags=d288 +FontValuesFlags=d288 +DILabel9=uListening To: +DIValue9=u%raw:/ListeningTo% +DILabel10=uLast message: (%sys:last_msg_reltime% ago) +DIValue10=u%sys:last_msg% +DILabel11=uStatus Message: +DIValue11=u%sys:status_msg% +DILabel12=uObservation time: +DIValue12=u%raw:Current/Update% +DILabel13=uVisibility: +DIValue13=u%raw:Current/Visibility% +DILabel14=uFeels like: +DIValue14=u%raw:Current/Feel% +DILabel15=uWind: +DIValue15=u%raw:Current/Wind Direction% (%raw:Current/Wind Direction DEG%)/%raw:Current/Wind Speed% +DILabel16=uHigh/Low: +DIValue16=u%raw:Current/High%/%raw:Current/Low% +DILabel17=uPressure: +DIValue17=u%raw:Current/Pressure% (%raw:Current/Pressure Tendency%) +DILabel18=uHumidity: +DIValue18=u%raw:Current/Humidity% +DILabel19=uUV Index: +DIValue19=u%raw:Current/UV% - %raw:Current/UVI% +DILabel20=uSunrise/Sunset: +DIValue20=u%raw:Current/Sunrise%/%raw:Current/Sunset% +DILabel21=uMoonphase +DIValue21=u%raw:Current/Moon% + + diff --git a/plugins/tipper/docs/autoexec_Tipper(Tweety).ini b/plugins/tipper/docs/autoexec_Tipper(Tweety).ini new file mode 100644 index 0000000000..46584f6767 --- /dev/null +++ b/plugins/tipper/docs/autoexec_Tipper(Tweety).ini @@ -0,0 +1,379 @@ +SETTINGS: + +[Tipper] +WORD to status description=d1 +NextFuncId=d17 +DWORD timestamp to time=d2 +DWORD timestamp to time difference=d3 +BYTE to Yes/No=d4 +BYTE to Male/Female (ICQ)=d5 +WORD to country name=d6 +DWORD to ip address=d7 +Day|Month|Year to date=d8 +Day|Month|Year to age=d9 +Hours|Minutes|Seconds to time=d10 +Day|Month|Year|Hours|Minutes|Seconds to time difference=d11 +DWORD timestamp to time (no seconds)=d12 +Hours|Minutes to time=d13 +DWORD timestamp to date (short)=d14 +DWORD timestamp to date (long)=d15 +WinWidth=d400 +WinMaxHeight=d400 +Transparency=b19 +Border=b0 +RoundCorners=b1 +Animate=b1 +TransparentBg=b0 +RightIcon=b0 +AVLayout=b2 +AVSize=d80 +TextIndent=d23 +ShowNoFocus=b1 +NumValues=w3 +FontFirstSize=b247 +FontFirstSty=b1 +FontFirstSet=b0 +FontFirstCol=d6572572 +FontLabelsSize=b247 +FontLabelsSty=b1 +FontLabelsSet=b0 +FontLabelsCol=d6572572 +FontValuesSize=b247 +FontValuesSty=b0 +FontValuesSet=b0 +FontValuesCol=d6049571 +ColourBg=d15987699 +Label0=uEtat +Type0=b0 +TransFunc0=w7 +Label1=uMessage d'état +Type1=b1 +TransFunc1=w7 +Label2=uDernier Message +Type2=b1 +TransFunc2=w2 +ShowStatusMsg=b1 +DSNumValues=w21 +DILineAbove0=b0 +DIValNewline0=b0 +DINumValues=w38 +DILineAbove1=b0 +DIValNewline1=b0 +DILineAbove2=b0 +DIValNewline2=b0 +DILineAbove3=b0 +DIValNewline3=b0 +DILineAbove4=b0 +DIValNewline4=b0 +Type3=b1 +TransFunc3=w3 +Type4=b1 +TransFunc4=w1 +Type5=b1 +TransFunc5=w1 +Type6=b0 +TransFunc6=w1 +DILineAbove5=b0 +DIValNewline5=b0 +Type7=b1 +TransFunc7=w1 +DILineAbove6=b0 +DIValNewline6=b0 +Type8=b1 +TransFunc8=w1 +Type9=b1 +TransFunc9=w1 +Name10=umetaS0 +Type10=b1 +TransFunc10=w1 +Name11=umetaS1 +Type11=b1 +TransFunc11=w1 +Name12=umetaS2 +Type12=b1 +TransFunc12=w1 +Name13=umetaS3 +Type13=b1 +TransFunc13=w1 +Type14=b1 +TransFunc14=w1 +Type15=b1 +TransFunc15=w1 +Type16=b1 +TransFunc16=w1 +DILineAbove7=b0 +DIValNewline7=b0 +DILineAbove8=b1 +DIValNewline8=b0 +DILineAbove9=b0 +DIValNewline9=b0 +DILineAbove10=b0 +DIValNewline10=b0 +Name14=umetaS4 +Name16=umetaS6 +Type17=b1 +TransFunc17=w1 +Name15=umetaS5 +Name17=umetaS7 +Type18=b1 +TransFunc18=w1 +Type19=b1 +TransFunc19=w0 +Type20=b1 +TransFunc20=w0 +Name18=umetaS8 +Type21=b1 +TransFunc21=w1 +DILineAbove11=b0 +DIValNewline11=b0 +Name19=umetaS9 +Name21=uStatus +Name22=uUIN +Type22=b1 +TransFunc22=w0 +DILineAbove12=b0 +DIValNewline12=b0 +RightLabels=b0 +TimeIn=w300 +DILineAbove17=b0 +DIValNewline17=b0 +DILineAbove18=b0 +DIValNewline18=b0 +DILineAbove19=b0 +DIValNewline19=b0 +DILineAbove20=b0 +DIValNewline20=b0 +DILineAbove21=b0 +DIValNewline21=b0 +DILineAbove13=b1 +DIValNewline13=b1 +DILineAbove14=b0 +DIValNewline14=b1 +DILineAbove15=b1 +DIValNewline15=b0 +DILineAbove16=b0 +DIValNewline16=b0 +DILineAbove22=b0 +DIValNewline22=b0 +Module1=s +Module2=s +Setting2=sRealIP +Module3=s +Setting3=sIdleTS +Module7=s +Module8=s +Module9=s +Module10=s +Module11=s +Module12=s +Module13=s +Module14=s +Module15=s +Module16=s +Module17=s +Module18=s +Module19=s +Module20=s +Module21=s +Setting21=sStatus +Module22=s +Setting22=sUIN +BorderCol=d6567708 +Setting7=sLogonTS +Setting8=sLogonTS +Setting9=sLogonTS +Setting10=sStatus0 +Setting11=sStatus1 +Setting12=sStatus2 +Setting13=sStatus3 +DILineAbove23=b0 +DIValNewline23=b0 +DILineAbove24=b0 +DIValNewline24=b0 +DILineAbove25=b1 +DIValNewline25=b1 +DILineAbove26=b1 +DIValNewline26=b1 +DILineAbove27=b1 +DIValNewline27=b1 +DILineAbove28=b1 +DIValNewline28=b0 +Setting14=sStatus4 +DILineAbove29=b0 +DIValNewline29=b0 +DILineAbove30=b0 +DIValNewline30=b0 +DILineAbove31=b0 +DIValNewline31=b0 +TitleLayout=b0 +Padding=w3 +Position=b1 +MinWidth=d300 +MinHeight=d0 +TransFuncId0=d5 +TransFuncId1=d7 +TransFuncId2=d7 +TransFuncId3=d3 +TransFuncId4=d14 +TransFuncId5=d12 +TransFuncId6=d1 +TransFuncId7=d3 +TransFuncId8=d14 +TransFuncId9=d12 +TransFuncId10=d1 +TransFuncId11=d1 +TransFuncId12=d1 +TransFuncId13=d1 +TransFuncId14=d1 +TransFuncId15=d1 +DILineAbove32=b0 +DIValNewline32=b0 +DILineAbove33=b0 +DIValNewline33=b0 +MaxWidth=d350 +MaxHeight=d400 +Opacity=b75 +DILabel21=uHumidity: +DILineAbove34=b0 +DIValNewline34=b0 +Module4=s +Setting15=sStatus5 +TransFuncId16=d1 +DILineAbove35=b0 +DIValNewline35=b0 +DILineAbove36=b0 +DIValNewline36=b0 +MouseTollerance=b16 +DILineAbove37=b0 +DIValNewline37=b0 +DILineAbove38=b0 +DIValNewline38=b0 +FontValues=uTahoma +FontLabels=uTahoma +FontFirst=uTahoma +xStatus: empty xStatus name to default name=d16 +DropShadow=b1 +RightValues=b0 +SBarTips=b1 +DividerCol=d10304821 +SidebarCol=d15391189 +AvatarRoundCorners=b0 +AvatarPadding=w6 +TextPadding=w4 +SidebarWidth=d22 +TransFuncId17=d1 +TransFuncId18=d1 +Name0=uGender +Module0=sUserInfo +Setting0=sGender +Name1=uicqIP +Setting1=sIP +Name2=uicqIPreal +DILabel20=uPressure: +DILabel39=uLast message: (%sys:last_msg_reltime% ago) +DIValue39=u%sys:last_msg% +DILineAbove39=b1 +DIValNewline39=b1 +DILabel0=uStatus: +DIValue0=u%Status% +DILabel4=uID: +DILabel1=uNick: +DIValue1=u%raw:/Nick% +DIValue29=u%raw:/CListName1% (%metaS1%) %raw:/Login1% +DILabel29=u%raw:/Protocol1%: +DILabel30=u%raw:/Protocol2%: +DILabel31=u%raw:/Protocol3%: +DILabel32=u%raw:/Protocol4%: +DIValue30=u%raw:/CListName2% (%metaS2%) %raw:/Login2% +DIValue31=u%raw:/CListName3% (%metaS3%) %raw:/Login3% +DIValue32=u%raw:/CListName4% (%metaS4%) %raw:/Login4% +DILabel38=u%raw:/Protocol9%: +DIValue38=u%raw:/CListName9% (%metaS9%) %raw:/Login9% +DILabel37=u%raw:/Protocol9%: +DIValue37=u%raw:/CListName9% (%metaS9%) %raw:/Login9% +DILabel35=u%raw:/Protocol7%: +DIValue35=u%raw:/CListName7% (%metaS7%) %raw:/Login7% +DILabel36=u%raw:/Protocol8%: +DIValue36=u%raw:/CListName8% (%metaS8%) %raw:/Login8% +DILabel33=u%raw:/Protocol5%: +DIValue33=u%raw:/CListName5% (%metaS5%) %raw:/Login5% +DILabel34=u%raw:/Protocol6%: +DIValue34=u%raw:/CListName6% (%metaS6%) %raw:/Login6% +FontFirstFlags=d288 +FontLabelsFlags=d288 +FontValuesFlags=d288 +DILabel16=uVisibility: +DILabel19=uHigh/Low: +DILabel28=u%raw:/Protocol0%: +DIValue28=u%raw:/CListName0% (%metaS0%) %raw:/Login0% +Name3=uidle_ago +Name4=uidle_date +Name5=uidle_time +Module5=s +Name6=ulastseen_status +Module6=sSeenModule +Setting6=sStatus +Setting16=sStatus6 +Setting4=sIdleTS +Setting5=sIdleTS +Name8=ulogon_date +Setting17=sStatus7 +Setting18=sStatus8 +TransFuncId19=d1 +DILabel13=uExtra status title: +DIValue13=u%raw:/XStatusName% +DILabel14=uExtra status message: +DIValue14=u%raw:/XStatusMsg% +DILabel15=uObservation time: +DIValue15=u%raw:Current/Update% +DIValue16=u%raw:Current/Visibility% +DILabel17=uFeels like: +DIValue17=u%raw:Current/Feel% +DILabel18=uWind: +DIValue18=u%raw:Current/Wind Direction% (%raw:Current/Wind Direction DEG%)/%raw:Current/Wind Speed% +DIValue19=u%raw:Current/High%/%raw:Current/Low% +DIValue20=u%raw:Current/Pressure% (%raw:Current/Pressure Tendency%) +DIValue21=u%raw:Current/Humidity% +DILabel22=uUV Index: +DIValue22=u%raw:Current/UV% - %raw:Current/UVI% +DILabel23=uSunrise/Sunset: +DIValue23=u%raw:Current/Sunrise%/%raw:Current/Sunset% +DILabel24=uMoonphase +DIValue24=u%raw:Current/Moon% +DILabel25=uTopic : +DIValue25=u%raw:/Topic% +DILabel26=uLast message: (%sys:last_msg_reltime% ago) +DIValue26=u%sys:last_msg% +DILabel27=uStatus message : +DIValue27=u%sys:status_msg% +Name9=ulogon_time +Setting19=sStatus9 +Name20=uStatus +Setting20=sStatus +TransFuncId20=d1 +DIValue8=u%raw:/MirVer% +DILabel11=uIdle: +DIValue11=u%idle_date% @ %idle_time% (%idle_ago%) +DILabel12=uLogon: +DIValue12=u%logon_date% @ %logon_time% (%logon_ago%) +Name7=ulogon_ago +DILabel8=uClient: +DILabel9=uIP: +DIValue9=u%icqIP% (%icqIPreal%) +DILabel10=uLast seen: +DIValue10=u%raw:SeenModule/Day%.%raw:SeenModule/Month%.%raw:SeenModule/Year% @ %raw:SeenModule/Hours%:%raw:SeenModule/Minutes%:%raw:SeenModule/Seconds% (%lastseen_status%) +DILabel2=uEmail: +DIValue2=u%raw:/e-mail% +DILabel3=uUIN: +DIValue3=u%raw:/UIN% +DIValue4=u%raw:/stid% +DILabel5=uID: +DIValue5=u%raw:/jid% +DILabel6=uGender: +DIValue6=u%Gender% +DILabel7=uBirthday: +DIValue7=u%raw:mBirthday/BirthDay%-%raw:mBirthday/BirthMonth%-%raw:mBirthday/BirthYear% ( %raw:UserInfo/Age% ) +DILineAbove28=b0 +DIValNewline28=b0 +DILabel28=uListening To: +DIValue28=u%raw:/ListeningTo% \ No newline at end of file diff --git a/plugins/tipper/docs/licence_Tipper.txt b/plugins/tipper/docs/licence_Tipper.txt new file mode 100644 index 0000000000..082744b8a8 --- /dev/null +++ b/plugins/tipper/docs/licence_Tipper.txt @@ -0,0 +1,6 @@ +The Tipper plugin for Miranda-IM is Copyright (c) 2006 Scott Ellis (mail@scottellis.com.au) + +http://www.scottellis.com.au + +It is released under the General Public Licence, available here: +http://www.gnu.org/copyleft/gpl.html \ No newline at end of file diff --git a/plugins/tipper/docs/m_tipper.h b/plugins/tipper/docs/m_tipper.h new file mode 100644 index 0000000000..031d490632 --- /dev/null +++ b/plugins/tipper/docs/m_tipper.h @@ -0,0 +1,23 @@ +// Tipper API +// note: Tipper is internally unicode and requires unicows.dll to function correctly on 95/98/ME +// so you'll find a lot of wchar_t stuff in here + +// use hContact, module and setting to read your db value(s) and put the resulting string into buff +// return buff if the translation was successful, or return 0 for failure +typedef wchar_t *(TranslateFunc)(HANDLE hContact, const char *module, const char *setting_or_prefix, wchar_t *buff, int bufflen); + +typedef struct { + TranslateFunc *tfunc; // address of your translation function (see typedef above) + const wchar_t *name; // make sure this is unique, and DO NOT translate it + DWORD id; // will be overwritten by Tipper - do not use +} DBVTranslation; + +// add a translation to tipper +// wParam not used +// lParam = (DBVTranslation *)translation +#define MS_TIPPER_ADDTRANSLATION "Tipper/AddTranslation" + +// unicode extension to the basic functionality +// wParam - optional (wchar_t *)text for text-only tips +// lParam - (CLCINFOTIP *)infoTip +#define MS_TIPPER_SHOWTIPW "mToolTip/ShowTipW" diff --git a/plugins/tipper/docs/readme_tipper.txt b/plugins/tipper/docs/readme_tipper.txt new file mode 100644 index 0000000000..bb8bd97183 --- /dev/null +++ b/plugins/tipper/docs/readme_tipper.txt @@ -0,0 +1,144 @@ +Document updated: 28/9/06 + +****** +Tipper - shows a tooltip when you hover the mouse over a contact in your contact list +****** + +Most options are self explanitory...except for 'items' and 'substitutions'. + +If you want to set this up yourself, you need a moderate understanding of the miranda database (profile) and the Database Editor++ plugin. + +The easiest way is to copy the autoexec_tipper.ini file (in the same folder as this document) to the miranda program folder and restart - +it will (normally) ask you if you wish to import the settings. If you click yes, you will find several examples in your Tipper options that +will get you started. You can also ask your nerdier miranda-using buddies to create such a file for you, if they have a good setup. + +To get an idea of how tipper works, try playing with items. Items are simply a label and some text (the value). Try adding some items. Once +you've played around a bit you'll get the idea, and then you'll understand the need for substitutions. + +Substitutions allow you to put useful, contact related, information into the label or value of an item. To create a substitution you need +to have a relatively good understanding of the miranda database - a few hours browsing with dbeditor++ will give you a clue. You create a +substitution by specifying a name and the database module and setting names for the data it will contain. You can then put this data into +any item (label or value) by enclosing the substitution name in '%' symbols. Many database values are not terribly friendly to humans, so +when creating a substitution, you can also choose a translation which will convert the value into a more readable format. + +To get technical: + +A 'Substitution' is a name for a database value, represented according to a particular translation. When creating new substitutions, you +specify its name, the database module (or the contact's protocol module) and the setting name. Then you select a translation from the drop +down list. This transformation will convert the database value into a string. + +An 'Item' is just a label and a value. However, any substitution names (surrounded by % symbols) occuring in either a label or a value will +be substituted as described above. If you want to put a % symbol in a value or label, use '%%' instead. + +A good example is representing a contacts status (as 'Online' etc) in the tooltip. + +First, create a substitution called 'status' (without quotes) - the module will be the contact's protocol module, the setting name will be +'Status' (without quotes - note the capital 'S') and the translation will be 'WORD to status description' (since this value is a WORD value +in the database). Then, create an item and specify 'Status:' for the label and '%status%' for the value. Done. + +There is also a built in substitution, called a 'raw' substitution. It is not listed in the substitution list, but it is available in all +labels and values. It's format is: + +%raw:/% + +No translation is performed on 'raw' values. For example, to display a contact's contact list group in the tooltip, add an item with the +label 'Group:' and the value '%raw:CList/Group%'. If you do not specify a module name (you must still include the '/'), the contact's +protocol module will be used. This is ultimately just a shortcut for the 'null translation'. + +There are also 'system' substitutions (thanks to y_b), also not listed but available in all item labels and values, with the following +format: + +%sys:% + +Were name can be any of the following: + +uid - contact's unique identifier +uidname - name of unique identifier +proto - contact's protocol +time - contact's time +status_msg - contact's status message +last_msg - last message received from contact +last_msg_time - time of last received message +last_msg_date - date of last received message +last_msg_reltime - relative time of last message (i.e. time between then and now) +meta_subname - nickname of active subcontact (for metacontacts) +meta_subuid - unique id of active subcontact +meta_subproto - active subcontact protocol (also for metacontacts) + +If a substitution's value results in no text (or nothing but spaces, tabs, newlines, and carriage returns), the whole item containing that +substitution will not be displayed. If there is an error during the substitution process (e.g. a substitution name that does not exist, an odd +number of % symbols, etc) then the value of that substitution will be "*". Note that you can use double-percent ("%%") in plain text (not in +substitutions) if you want an actual percent symbol. + +ADVANCED +-------- + +Alternative Text: +In any substitution you can have 'alternate text' to use if the substitution fails (missing db value, etc). The format is: + +%x|y% + +where x is the original substitution and y is the alternative text. Note that you can use '|' in the alternative text, since it uses the +*first* occurence to determine where the alternative text begins. Normally if any substitution results in no value, the entire item will not +be displayed - but if you omit the 'y' value above (i.e. have nothing for the 'alternate' text) then the substitution process will continue. +As an example, consider the following item value: + +%raw:/FirstName|% %raw:/LastName% + +The above value will display the contact's first name if it's available, and then their last name - but if the last name is not available, the +entire item will not be displayed. + +Specific protocol: +If you end a substitution with '^' and a protocol name, then that substitution will only be displayed if the contact belongs to the given +protocol: + +%x^y% + +where y is the protocol name. If you want to display an item for every protocol *except* one, use + +%x^!y% + +If you use alternative text and specific protocol together, specify the alternative text first: + +%x|y^z% + +In such substitutions you can use a '^' symbol in the alternative text, as Tipper will take the *last* '^' symbol as the start of the protocol +specifier. If you want to use a '^' symbol in alternative text without a specific protocol, just append a '^' to the end of the descriptor, +e.g.: + +%x|y^% + + +'HIDDEN' DB SETTINGS +-------------------- + +Due to space constraints in the options page and my own laziness, the following settings are only accessible via the database (i.e. using dbeditor++): + +DWORD Tipper/MinHeight +DWORD Tipper/MinWidth +WORD Tipper/AvatarPadding +WORD Tipper/TextPadding (space between lines of text) +DWORD Tipper/SidebarWidth +BYTE Tipper/MouseTollerance (distance mouse can move while tip is shown, before it is automatically closed, in pixels) +BYTE Tipper/AvatarRoundCorners + + +******************** +'Variables' support: +******************** + +This plugin supports the variables plugin by UnregistereD (http://www.cs.vu.nl/~pboon/variables.zip) + +Be sure to use the unicode version! + +All text in 'Items' - that is, labels and values, will be processed by variables BEFORE Tipper substitutions are applied. + + +Good luck and have fun. + + +Scott +mail@scottellis.com.au +www.scottellis.com.au + +p.s. Thanks to Omniwolf and Tweety for compiling autoexec_Tipper(*).ini files -- cgit v1.2.3