Changes between Version 13 and Version 14 of Documentation/DevelopmentCenter/CreateNewPluginUsingVS


Ignore:
Timestamp:
06/26/14 19:00:52 (5 years ago)
Author:
abeham
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/DevelopmentCenter/CreateNewPluginUsingVS

    v13 v14  
    1111 * In this guide we'll use "GreatIdea" as name and choose the `extension` folder as location
    1212
    13 [[Image(create_solution.png)]]
     13[[Image(create_solution.png, 70%, align=center)]]
    1414
    1515Next we add a new project to this solution.
     
    3131
    3232'''Assembly information'''
    33  We set the assembly version to the same value as the current HeuristicLab version by convention. In the official HeuristicLab repository the revision part is synchronized with the SVN revision number, it can be simply set to 0 in our case. Changing major or minor version numbers in the course of development marks a breaking change to previously saved files. If HeuristicLab wants to load an item of a plugin with version 3.3.8 it will accept the same plugin in version 3.3.9 to open it. However, it will reject the plugin when its major or minor is different (e.g. 3.2.7, 3.4.3 or 4.0.1). The "Assembly file version" is not used by HeuristicLab and can be set without any restrictions.
     33 We set the assembly version to the same value as the current HeuristicLab version by convention. It should only include major and minor, build and revision should always remain 0. In the official HeuristicLab repository the revision part is synchronized with the SVN revision number, it can be simply set to 0 in our case. The assembly file version can include the whole version string.
    3434
    3535'''Build'''
     
    3939 On the "Debug" tab choose "Start external program" and select HeuristicLab.exe inside StableRoot\bin - this setting is stored in the .csproj.user file.
    4040
    41 [[Image(debug_options.png)]]
     41[[Image(debug_options.png, align=center)]]
    4242
    4343'''Signing'''
    4444 Activate "Sign the assembly" and create a new key or use the HeuristicLab.snk inside the plugins of StableRoot. Otherwise call the new key "TheKey", but deselect the password option.
    4545
    46 Save and close the project's properties.
     46Save and close the project's properties. These changes ensure that the generated plugin is automatically added as a plugin to the HeuristicLab build and that we can use our solution to start a debugging session (shortcut <F5>). Now, we want to make this class library a HeuristicLab plugin.
    4747
    4848=== References ===
    49 Every HL plugin has at least a reference to !PluginInfrastructure as this is needed for the Plugin.cs file. Therefore add a reference to this plugin:
     49Every plugin has at least a reference to HeuristicLab.PluginInfrastructure as this is needed for the Plugin.cs file. Therefore add a reference to this plugin:
    5050
    5151[[Image(add_reference.png)]]
     
    7373  }}}
    7474
     75'''Important''': Changing major or minor version numbers in the course of development marks a breaking change to previously saved files. If HeuristicLab wants to load an item of a plugin with version 3.3.8 it will accept the same plugin in version 3.3.9 to open it. However, it will reject the plugin when its major or minor is different (e.g. 3.2.7, 3.4.3 or 4.0.1). The "Assembly file version" is not used by HeuristicLab and can be set without any restrictions.
    7576
    7677=== Build path ===