Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Stardust/ContributingDocumentation"
m |
m |
||
Line 20: | Line 20: | ||
# <p>Click '''Next'''</p> | # <p>Click '''Next'''</p> | ||
# <p>Enter a project name, e.g. ''org.eclipse.stardust.docs.mydocs''</p> | # <p>Enter a project name, e.g. ''org.eclipse.stardust.docs.mydocs''</p> | ||
− | # <p>In the '''Location''' field enter the location of your checked out | + | # <p>In the '''Location''' field enter the location of your checked out ''stardust/documentation'' followed by the plugin name.</p>[[Image:enter-proj-details.png]]<br><br> |
# <p>Click '''Next'''</p> | # <p>Click '''Next'''</p> | ||
# <p>In the '''Content''' dialog click '''Next'''</p>[[Image:create-plugin-data.png]]<br><br> | # <p>In the '''Content''' dialog click '''Next'''</p>[[Image:create-plugin-data.png]]<br><br> | ||
Line 46: | Line 46: | ||
=== Including the Documentation Plugin in the Stardust Documentation Feature === | === Including the Documentation Plugin in the Stardust Documentation Feature === | ||
<p>To include your new documentation plugin in the documentation feature, edit the '''org.eclipse.stardust.documentation.documentation-feature''' feature plugin and add your plugin as follows:</p> | <p>To include your new documentation plugin in the documentation feature, edit the '''org.eclipse.stardust.documentation.documentation-feature''' feature plugin and add your plugin as follows:</p> | ||
− | # <p>In the ''Plug-ins and Fragments'' view, click the ''Add'' button.</p>[[Image:doc-feature-add.png]]<br><br> | + | # <p>In the '''Plug-ins and Fragments''' view, click the '''Add''' button.</p>[[Image:doc-feature-add.png]]<br><br> |
# <p>In the upcoming dialog select your documentation plugin.</p>[[Image:doc-feature-select.png]]<br><br> | # <p>In the upcoming dialog select your documentation plugin.</p>[[Image:doc-feature-select.png]]<br><br> | ||
+ | # Click '''OK''' | ||
# <p>You can now see your documentation plugin in the list of packaged plug-ins.</p>[[Image:doc-feature-added.png]]<br><br> | # <p>You can now see your documentation plugin in the list of packaged plug-ins.</p>[[Image:doc-feature-added.png]]<br><br> | ||
# Save the change | # Save the change | ||
− | + | <p>You find the following entry containing your documentation plugin id added to the ''features.xml'' file:</p> | |
<pre> | <pre> | ||
<plugin | <plugin |
Revision as of 07:25, 18 November 2015
Contents
Contributing Documentation to Stardust
Stardust Documentation Git Repository
To contribute to our Stardust documentation you need to check out the documentation git repository from the desired branch.
The documentation git repository is git.eclipse.org/c/stardust/org.eclipse.stardust.documentation.git.
Please refer to our Source Code and Contributing via Gerrit Wiki pages for details on how to clone and check out Stardust git repositories.
The Stardust documentation consists of several documentation plugins, which are linked to the main documentation. You can easily contribute to our documentation by adding or linking a custom documentation plugin.
If you already have a local documentation plugin you like to link into Stardust documentation, proceed with Linking a Documentation Plugin to Stardust Documentation.
If you have documentation you like to put into a documentation plugin to be linked into Stardust documentation, you need to create a plugin project, in which you create or copy your documentation. Proceed with Creating a new Documentation Plugin in that case.
Creating a new Documentation Plugin
Create a new plugin project:
-
Select New & Project & Plug-in Project
-
Click Next
-
Enter a project name, e.g. org.eclipse.stardust.docs.mydocs
-
In the Location field enter the location of your checked out stardust/documentation followed by the plugin name.
-
Click Next
-
In the Content dialog click Next
-
Select the Create a plug-in using one of the templates option
-
In the Available templates section select Plug-in with sample help content
-
Click Next
-
In the Sample Help Table of Contents dialog, select Primary and add an appropriate label.
Editing the Documentation Plugin
Now you see the new plugin in your workspace.
You find example html files added in the html folder. These files are linked from the toc.xml table of contents file and serve as examples to demonstrate the plugin structure and toc usage.
Remove the example html files and add your custom documentation. Edit the toc.xml and replace the topics with your custom documentation topics and subtopics
Linking a Documentation Plugin to Stardust Documentation
Adding a Link to the main Documentation Plugin
The main documentation plugin is org.eclipse.stardust.docs.dev. It contains an anchor additional_handbooks in the main toc.xml file. All additional documentation toc files can be linked to this anchor.
To link your documentation plugin to the Stardust Documentation, enter the following link_to entry to the top toc line in your toc.xml file:
link_to="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/toc.xml#additional_handbooks"
Including the Documentation Plugin in the Stardust Documentation Feature
To include your new documentation plugin in the documentation feature, edit the org.eclipse.stardust.documentation.documentation-feature feature plugin and add your plugin as follows:
-
In the Plug-ins and Fragments view, click the Add button.
-
In the upcoming dialog select your documentation plugin.
- Click OK
-
You can now see your documentation plugin in the list of packaged plug-ins.
- Save the change
You find the following entry containing your documentation plugin id added to the features.xml file:
<plugin id="org.eclipse.stardust.docs.mydocs" download-size="0" install-size="0" version="0.0.0"/>
Style Guide
Please refer to the Eclipse Doc Style Guide for a general guide on Eclipse documentation styling.
To provide our Stardust documentation style, copy the styles folder, which you find in the following zip file, to the html folder of your documentation plugin: styles.zip
This folder contains the carnot.css Stardust style sheet containing style classes for headers, lists etc. A subfolder images contains bullet images and the Stardust logo used in the first heading.