Warning, /frameworks/kio/templates/kioworker/README.md is written in an unsupported language. File is not indexed.

0001 KIO Worker Template
0002 ----------------------
0003 
0004 ### Build instructions
0005 
0006 ```
0007 cd /where/your/project/is/created
0008 mkdir build
0009 cd build
0010 cmake \
0011     -DKDE_INSTALL_PLUGINDIR=`kf5-config --qt-plugins` \
0012     -DKDE_INSTALL_KSERVICESDIR=`kf5-config --install services` \
0013     -DKDE_INSTALL_LOGGINGCATEGORIESDIR=`kf5-config --install data`qlogging-categories5 \
0014     -DCMAKE_BUILD_TYPE=Release  ..
0015 make
0016 make install
0017 ```
0018 
0019 After this you can test the new protocol with:  
0020 `kioclient5 'ls' 'myproto:///'`  
0021 `kioclient5 'cat' 'myproto:///Item A'`
0022 
0023 You can also explore the new protocol with dolphin or konqueror:  
0024 `dolphin myproto:///`
0025 
0026 
0027 ### Adaption instructions
0028 
0029 Because the KAppTemplate format does not yet allow custom variables,
0030 the template uses "myproto" in the generated sources as the initial name of the scheme.
0031 Grep for all instances of that string in all files and replace it with the name of your scheme,
0032 and rename the `myproto.protocol` file accordingly.
0033 
0034 The class `MyDataSystem` just serves as a starting point to see something working right
0035 after creating the project. Replace that class and the calls to it with code as needed to map
0036 the KIO system to the actual data service/system your KIO worker is wrapping.
0037 
0038 
0039 ### Related documentation
0040 
0041 Find the documentation of `KIO::WorkerBase` for the API to implement at
0042 https://api.kde.org/frameworks/kio/html/classKIO_1_1WorkerBase.html
0043 
0044 Learn about debugging your new KIO worker at
0045 https://community.kde.org/Guidelines_and_HOWTOs/Debugging/Debugging_IOSlaves