Ticket #922 (closed defect: fixed)

Opened 3 years ago

Last modified 2 years ago

improve plugin-name example config file

Reported by: mkoller Owned by: bricks
Priority: high Milestone: OpenSync 0.40
Component: OpenSync: API Documentation Version: 0.38
Severity: normal Keywords:
Cc:

Description

it would be helpful if the file "plugin-name" ./opensync/docs/example-plugin/src/plugin-name would actually contain an example of some config options instead of the text it currently holds, e.g. matching the implementation of plugin.c where I see how to use the advancedoptions

Change History

comment:1 Changed 2 years ago by dgollub

  • Owner changed from dgollub to bricks
  • Component changed from OpenSync to OpenSync: API Documentation

This is still present for current trunk.

comment:2 Changed 2 years ago by Bloosky

Something to start with. Anyone can check/improve it?

<!-- This file will hold the default configuration options of your plugin. -->

<?xml version="1.0"?>
<config version="1.0">
  <!-- Advanced options (optional)-->
  <AdvancedOptions>
   <AdvancedOption>
     <!-- Advanced option settings -->
     <DisplayName>advanced_option</DisplayName>
     <Name>option_name</Name>
     <Type>option_type</Type>
     <Value>option_value</Value>
   </AdvancedOption>
  </AdvancedOptions>

  <Resources>
    <Resource>
     <Enabled>1</Enabled>
     <Formats>
       <Format>
         <!-- Format name (vevent20, vtodo20, vcard30, ...)-->
         <Name>format_name</Name>
       </Format>
     </Formats>
     <!-- Object type (event, todo, contact, ...) -->
     <ObjType>object_type</ObjType>
     <!-- Path to sync -->
     <Path>/path/to/sync/</Path>
    </Resource>
  </Resources>
</config>

comment:3 Changed 2 years ago by dgollub

  • Status changed from new to closed
  • Resolution set to fixed

(In [5999]) Added some simple plugin configuration with resources configuration. Even that resources configuration is optional. Most plugin starts might want to start with hardcoded resources configuration.

fixes #922

Note: See TracTickets for help on using tickets.