From 4aed2c8219774f5d797760606b8489a92ddc5163 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdebase@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- kcontrol/kio/UA-DESKTOP-FILE-HOWTO | 135 +++++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 kcontrol/kio/UA-DESKTOP-FILE-HOWTO (limited to 'kcontrol/kio/UA-DESKTOP-FILE-HOWTO') diff --git a/kcontrol/kio/UA-DESKTOP-FILE-HOWTO b/kcontrol/kio/UA-DESKTOP-FILE-HOWTO new file mode 100644 index 000000000..8d67d9a37 --- /dev/null +++ b/kcontrol/kio/UA-DESKTOP-FILE-HOWTO @@ -0,0 +1,135 @@ +Mini HOWTO create a "User-Agent" description file for KDE +========================================================= + +This mini HOWTO describes the procedure for creating a new user-agent +description file to extend the ones that come pre-packaged with KDE. +The purpose of a user agent description file is to fake or spoof sites +that refuse to render pages with the default KDE user-agent identification. + +In order to create new user-agent description files, simply follow the +normal desktop file specifications set by the "DESKTOP ENTRY STANDARD" +augmented with the following requirements: + +REQUIREMENTS: +============= +The following properties as defined by the DESKTOP ENTRY STANDARD +must be set as shown below: + +Name=UADescription (XXXX) +Type=Service +ServiceTypes=UserAgentStrings + +Though the (XXXX) value shown above can be any text, it is a good idea +to make it a short identification of the browser being emulated. However, +there is NO requirement on what the text should be. It can even be left +out. It is only meant to give people a quick idea which browser is being +emulated by your desktop file. + +NEW PROPERTIES: +=============== +X-KDE-UA-TAG +FIELD: REQUIRED +TYPE: QString +TRANSLATE: NO +DESCRIPTION: +An abbreviation of the actual browser-brand and is used +to group the entries whenever necessary. Currently there are 5 +approximations: IE, NN, MOZ, OP, MISC. These represent Internet +Explorer, Netscape Navigator, Mozilla, Opera and Miscellaneous +respectively. NOTE: you can enter any value here as it is just +a place holder that would be automatically replaced with the +actual user-agent name (X-KDE-UA-NAME). + +X-KDE-UA-FULL +FIELD: REQUIRED +TYPE: QString +TRANSLATE: NO +DESCRIPTION: +The full user-agent description that will be sent to the remote +site. It can contain the following keywords that would be replaced +with the appropriate value as defined by "uname": + +appSysName the name of the operating system (ex: Linux). +appPlatform the name of the platform. Currently hardcoded to "X11". +appLanguage the language values as set in the control panel (ex: en, en-US). +appSysRelease the version of the operating system (ex: 2.2.18). +appKDERelease the current release number as set by KDE (ex: 2.1.9 >=20010310). +appMachineType the processor or machine type (ex: i686). + +NOTE: if you use any of these values and want them to be replaced +automatically, make sure you include the X-KDE-UA-DYNAMIC-ENTRY field +and set its value to 1 (for true). + +X-KDE-UA-NAME +FIELD: REQUIRED +TYPE: QString +TRANSLATE: YES +DESCRIPTION: +The actual name of the browser or user-agent. + +X-KDE-UA-VERSION +FIELD: REQUIRED +TYPE: QString +TRANSLATE: YES +DESCRIPTION: +The actual version of the browser or user-agent. + +X-KDE-UA-SYSNAME +FIELD: OPTIONAL +TYPE: QString +TRANSLATE: YES +DESCRIPTION: +The system name (for example Linux) where the browser +identification was obtained from. + +X-KDE-UA-SYSRELEASE +FIELD: OPTIONAL +TYPE: QString +TRANSLATE: YES +DESCRIPTION: +The system version (for example 2.4.1) where the browser +identification was obtained from. + +X-KDE-UA-DYNAMIC-ENTRY +FIELD: OPTIONAL +TYPE: BOOLEAN (0/1) +TRANSLATE: NO +DESCRIPTION: +A boolean that indicates whether the keywords described under +X-KDE-UA-FULL should be translated. Make sure this field is +there with its value set to "1" if you want the keywords to +be replaced appropriately. + + +EXAMPLES: +========= +[Desktop Entry] +Name=UADescription (IE 5.5 on Win 98) +Type=Service +ServiceTypes=UserAgentStrings +X-KDE-UA-TAG=IE +X-KDE-UA-FULL=Mozilla/4.0 (compatible; MSIE 5.5; Windows 98) +X-KDE-UA-NAME=Internet Explorer +X-KDE-UA-VERSION=5.5 +X-KDE-UA-SYSNAME=Windows +X-KDE-UA-SYSRELEASE=98 + +[Desktop Entry] +Name=UADescription (NN 4.76 on current) +Type=Service +ServiceTypes=UserAgentStrings +X-KDE-UA-TAG=NN +X-KDE-UA-FULL=Mozilla/4.76 (appPlatform; U; appSysName appSysRelease appMachineType) +X-KDE-UA-NAME=Netscape Navigator +X-KDE-UA-VERSION=4.76 +X-KDE-UA-DYNAMIC-ENTRY=1 + +The first entry is a description file for Internet Explorer running on +a Windows 98 machine while the second one is an example of a description +file for Netscape browser using the "keyword" based approach to describe +the fields that should be replaced dynamically based on the current system +settings. Note that all "keyword" based desktop files should always set +X-KDE-UA-DYNAMIC-ENTRY to 1. + +Enjoy, +Dawit A. -- cgit v1.2.1