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 "Higgins Specs"
(New page: This is the cover page for three drafts of Higgins specifications: * Higgins Identifiers * Higgins Context Discovery * Higgins Data Model These are XML files that can be converted to HTM...) |
|||
| Line 1: | Line 1: | ||
| − | This | + | This page describes an effort to create the following three Higgins Spec documents: |
* Higgins Identifiers | * Higgins Identifiers | ||
| Line 35: | Line 35: | ||
== Editing == | == Editing == | ||
| − | The three XML files are in the org.eclipse.higgins.doc project. | + | The three XML files are in the '''org.eclipse.higgins.doc''' project. |
The complete SVN path is '''/org.eclipse.higgins/trunk/doc/org.eclipse.higgins.doc/Specs/'''. | The complete SVN path is '''/org.eclipse.higgins/trunk/doc/org.eclipse.higgins.doc/Specs/'''. | ||
| Line 61: | Line 61: | ||
== TODO == | == TODO == | ||
| − | * Look through the docs and fix bugs, complete missing sections, etc. in order to produce first complete drafts | + | * Look through the docs and fix bugs, complete missing sections, etc. in order to produce first complete drafts |
* Determine final URLs for these docs (they reference each other by absolute URLs) | * Determine final URLs for these docs (they reference each other by absolute URLs) | ||
* Decide on list of editors | * Decide on list of editors | ||
* Decide on filenames (i.e. something better than draft-higgins-identifiers.html) | * Decide on filenames (i.e. something better than draft-higgins-identifiers.html) | ||
Revision as of 11:27, 15 February 2008
This page describes an effort to create the following three Higgins Spec documents:
- Higgins Identifiers
- Higgins Context Discovery
- Higgins Data Model
These are XML files that can be converted to HTML files.
Contents
Specs
Higgins Identifiers
HTML file in SVN: http://dev.eclipse.org/viewsvn/index.cgi/org.eclipse.higgins/trunk/doc/org.eclipse.higgins.doc/Specs/draft-higgins-identifiers.html?root=Technology_SVN&view=log
Higgins Context Discovery
Higgins Data Model
HTML file in SVN: http://dev.eclipse.org/viewsvn/index.cgi/org.eclipse.higgins/trunk/doc/org.eclipse.higgins.doc/Specs/draft-higgins-datamodel.html?root=Technology_SVN&view=log
Editing
The three XML files are in the org.eclipse.higgins.doc project.
The complete SVN path is /org.eclipse.higgins/trunk/doc/org.eclipse.higgins.doc/Specs/.
They can the be edited using any XML or text editor. Do not edit the HTML files directly!
How to convert to HTML
In order to convert one of the XML files to HTML, the "xml2rfc" tools has to be used. Follow these steps:
- Go to http://xml.resource.org/
- Fill in the "Convert Your XML Source" form as follows:
- Input file: Upload the XML file you want to convert here
- Output mode: HTML
- Output result: Window (if you just want to validate/preview your XML) or File (if you want to download the resulting HTML file)
After you made changes to the XML file and converted it to HTML, commit both files back to the SVN.
Tips
- The rfc2xml tool is not very forgiving. If it encounters XML elements it does not like, it throws error messages which may be hard to understand. Therefore always make sure the XML file can be converted to HTML, before committing your changes to the SVN.
TODO
- Look through the docs and fix bugs, complete missing sections, etc. in order to produce first complete drafts
- Determine final URLs for these docs (they reference each other by absolute URLs)
- Decide on list of editors
- Decide on filenames (i.e. something better than draft-higgins-identifiers.html)