Changes between Version 10 and Version 11 of Documentation


Ignore:
Timestamp:
Oct 22, 2019, 11:00:46 AM (2 years ago)
Author:
kopal
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation

    v10 v11  
    1 This document explains how to create a documentation for a CrypTool 2.0 component for the new online, XML based, documentation system.
     1This document explains how to create a documentation for a CrypTool 2 component for the new online, XML based, documentation system.
    22
    33First, create (by using Visual Studio) a new xml file inside the C# project of the component which you want to documentate.
     
    1515You have to insert the path to the new XML file as a string there. For the SDES Plugin, this path is "SDES/DetailedDescription/doc.xml" (note the fact, that the path must contain the assembly name).
    1616
    17 Now, CrypTool 2.0 knows where to find the documentation file of the component.
     17Now, CrypTool 2 knows where to find the documentation file of the component.
    1818What's left is filling the XML file with appropriate content.
    1919
     
    4747
    4848* '''Introduction:''' Should explain something about the purpose and maybe the history of the component or its underlying technique.
    49 * '''Usage:''' Should contain some instruction on how to use this component in CrypTool 2.0.
     49* '''Usage:''' Should contain some instruction on how to use this component in CrypTool 2.
    5050* '''Presentation:''' Should explain something about the visual presentation of this component (if available).
    5151
     
    6666 * The "enum" tag, which enumerates elements given by "item" tags (see below).
    6767 * The "list" tag, which lists elements (unordered) given by "item" tags (see below).
    68  * <docRef item="Cryptool.TextInput.TextInput"/> to reference the documentation of another CrypTool 2.0 component
     68 * <docRef item="Cryptool.TextInput.TextInput"/> to reference the documentation of another CrypTool 2 component
    6969 * <external ref="http://en.wikipedia.org/wiki/Main_Page"/> to reference external URLs.
    7070 * <img src="TextInput/Documentation/Demonstration.png"/> to include images (see below how to handle the image file inside the project).