Warning, /pim/akonadi/templates/akonadiresource/README is written in an unsupported language. File is not indexed.
0001 How To Build This Template 0002 -=-=-=-=-=-=-=-=-=-=-=-=-= 0003 0004 --- On Linux & similar: 0005 0006 cd <project_name_path> 0007 mkdir build 0008 cd build 0009 cmake .. -DCMAKE_INSTALL_PREFIX=$MY_PREFIX -DCMAKE_BUILD_TYPE=Debug 0010 make 0011 make install or su -c 'make install' 0012 0013 (MY_PREFIX is where you install your Akonadi setup, replace it accordingly) 0014 0015 to uninstall the project: 0016 make uninstall or su -c 'make uninstall' 0017 0018 Note: you can use another build path. Then cd in your build dir and: 0019 export MY_SRC=path_to_your_src 0020 cmake $MY_SRC -DCMAKE_INSTALL_PREFIX=$MY_PREFIX -DCMAKE_BUILD_TYPE=Debug 0021 0022 --- On Windows: 0023 0024 cd <project_name_path> 0025 mkdir build 0026 cd build 0027 cmake .. -DCMAKE_INSTALL_PREFIX=%MY_PREFIX% -DCMAKE_BUILD_TYPE=Debug 0028 [n]make 0029 [n]make install 0030 0031 (MY_PREFIX is where you install your Akonadi setup, replace it accordingly) 0032 0033 to uninstall the project: 0034 [n]make uninstall 0035 0036 Note: use nmake if you're building with the Visual Studio compiler, or make 0037 if you're using the minGW compiler 0038 0039 0040 Implementation hints 0041 -=-=-=-=-=-=-=-=-=-= 0042 0043 The code generated by the template can be compiled without any further 0044 changes, so you can start with your own code right away. 0045 0046 However, there are a couple of things you will need to change outside the 0047 resource's code, i.e. in the resource's .desktop file: 0048 0049 - Name field: the name of the resource with which it will be displayed in 0050 system settings and applications which can add resources on their own. 0051 E.g. MyBackend Resource 0052 0053 - Comment field: short description of the resource, also used to be 0054 displayed, e.g. For calendars and contacts stored in MyBackend 0055 0056 - Icon field: if you are not writing a contact (addressbook) resource, you have 0057 to change this to either an icon for the respective MIME type you are going 0058 to provide or use a resource specific icon which you provide yourself 0059 0060 - X-Akonadi-MimeTypes field: if you are not writing a contact (addressbook) 0061 resource, you have to change this to either a known MIME type or one you 0062 install together with the resource. 0063 If your resource can provide data of more than one MIME type, you can 0064 specific all possible ones as a comma separate list. 0065 0066 Common MIME types are: 0067 * text/directory: for contact data 0068 * text/calendar: for calendar data (there are Akonadi defined subtypes 0069 available, e.g. application/x-vnd.akonadi.calendar.event) 0070 * message/rfc822: for e-mails and usenet news 0071 0072 The template comes with an input file for KDE's KConfigXT framework 0073 for improved configuration file handling. The generated class is called 0074 "Settings", so access to its data is provided through its singleton 0075 instance method Settings::self(). 0076 See https://techbase.kde.org/Development/Tutorials/Using_KConfig_XT 0077 0078 0079 Documentation 0080 -=-=-=-=-=-=- 0081 0082 The Akonadi-KDE API documentation can be found here: 0083 https://api.kde.org/kdepim/akonadi/html/index.html 0084 0085 General developer information, e.g. tutorials can be found here: 0086 https://techbase.kde.org/KDE_PIM/Akonadi 0087 0088 The contact site can be found here: 0089 https://community.kde.org/KDE_PIM/Contact