-
Notifications
You must be signed in to change notification settings - Fork 43
Online Help
The JCrypTool help is based on a fixed structure which makes it easy for end users to navigate and to find certain help content. This requires all JCrypTool plug-ins to follow this structure and to extend the help contents only at the defined points.
No plug-in is allowed to extend the help content on the top level, meaning there is no other entry allowed on the level of our main end user guide.
The complete help is available in two languages (German and English). Plug-in developers are encouraged to provide both languages as well and to use the default Eclipse mechanisms to achieve that goal (by using the nl directories). Remember to add those directories to the build.properties file; otherwise they will be missing in the binary build.
Each help must be made available in the HTML format. Avoid using your own CSS stylings. Each page must have a header using the h1 tag. Text contained in this h1 element must be repeated in the title element inside the page head.
Special characters (like German umlauts) don't have to be entered as HTML entities.
Eclipse offers only a basic spell check. Please use your text application in order to avoid nasty typos.
If you include pictures in the online help please give them a width in %. This avoids ugly horizontal scrollbars in the online help on low-resolution displays. The following code centers images and displays them at 90% of the available width.
<p align="center"><img src="setup2.png" width="90%"></p>
You can just paste it into an html document without having to worry about css or anything like that. Of course you have to replace setup2.png with the name of your image.
Help consists of one category only: User Guide. Only this category can be extended.
Use the link_to attribute to integrate a help page into a certain topic, e.g. link_to="../org.jcryptool.core.help/$nl$/toc.xml#visualizations" to integrate a help page into the visualizations category. A complete toc.xml for a classic algorithm plug-in for example looks like this:
<toc label="Caesar" link_to="../org.jcryptool.core.help/$nl$/toc.xml#classicAlgorithmPlugins">
<topic label="Caesar Encryption" href="$nl$/help/content/tutorial.html" />
</toc>
The user guide should make the first steps of new users as easy as possible. Every plug-in, normal and crypto plug-ins, should at least provide one page with informations on how to use it. In depth cryptographic information can be contained here too. This category answers the questions, what a user can do with a plug-in and how he can do it.
| Description | ID |
|---|---|
| General Information | general |
| Editors | editors |
| Views | views |
| Preferences | preferences |
| Algorithms | algorithmPlugins |
| Encryption (Classic) | classicAlgorithmPlugins |
| Encryption (Asymmetric) | asymmetricAlgorithmPlugins |
| Encryption (Symmetric) | symmetricAlgorithmPlugins |
| Encryption (Hybrid) | hybridAlgorithmPlugins |
| Hash | hashPlugins |
| MAC | macPlugins |
| Random Number | randomNumberPlugins |
| Signature | signaturePlugins |
| Analysis | analysisPlugins |
| Visualizations | visualizationPlugins |
| Games | gamePlugins |
Need help? Please visit the public JCT Chatroom or open a new Issue and ask your question. We'll be happy to assist you!