Difference between revisions of "JFace Data Binding/Wiki Guidelines"

From Eclipsepedia

Jump to: navigation, search
(New page: The articles contained at and under JFace Data Binding create the core documentation for the project. This article will provide guidelines for structing the documentation for the proj...)
 
(Added Side Bar section)
 
Line 1: Line 1:
 
The articles contained at and under [[JFace Data Binding]] create the core documentation for the project.  This article will provide guidelines for structing the documentation for the project.
 
The articles contained at and under [[JFace Data Binding]] create the core documentation for the project.  This article will provide guidelines for structing the documentation for the project.
 
+
{{JFace Data Binding}}
 
=Who Can Edit=
 
=Who Can Edit=
 
Anyone is welcome to edit the articles for JFace Data Binding.  Feel free to fix typos, clean up confusing text, or write new articles.  If contributing a large amount of documentation it might be a good idea to log a bug letting us know of the contribution.  This is not a requirement but it will help us ensure that the message is consistent and that we're keeping the structure of the site consistent.
 
Anyone is welcome to edit the articles for JFace Data Binding.  Feel free to fix typos, clean up confusing text, or write new articles.  If contributing a large amount of documentation it might be a good idea to log a bug letting us know of the contribution.  This is not a requirement but it will help us ensure that the message is consistent and that we're keeping the structure of the site consistent.
Line 12: Line 12:
 
The category will allow for documents that aren't necessarilly part of the core documentation, or part of the article hierarchy, to be aggregated.
 
The category will allow for documents that aren't necessarilly part of the core documentation, or part of the article hierarchy, to be aggregated.
  
 +
=Side Bar=
 +
On some of the JFace Data Binding pages you'll see a side bar on the top right.  This is done with the JFace Data Binding Template.
 +
 +
<nowiki>{{JFace Data Binding}}</nowiki>
 +
 +
The recommendation is to put this towards the top of the page.  It is provided so that we can create a feeling of a site within our documentation.
 
[[Category:Data Binding]]
 
[[Category:Data Binding]]

Latest revision as of 19:30, 6 September 2007

The articles contained at and under JFace Data Binding create the core documentation for the project. This article will provide guidelines for structing the documentation for the project.

JFace Data Binding
Home
How to Contribute
FAQ
Snippets
Concepts
Binding
Converter
Observable
Realm

Contents

[edit] Who Can Edit

Anyone is welcome to edit the articles for JFace Data Binding. Feel free to fix typos, clean up confusing text, or write new articles. If contributing a large amount of documentation it might be a good idea to log a bug letting us know of the contribution. This is not a requirement but it will help us ensure that the message is consistent and that we're keeping the structure of the site consistent.

[edit] Structure

Articles that document core concepts, code, policy, or procedure of the JFace Data Binding project should be subpages of the main article JFace Data Binding. In order to create a subpage append a '/' and then the new article name to the URL of the main page. MediaWiki will handle the rest. This will place a link at the top of the article back to the main article providing context. Not all articles need to be children of the main as a structured hierarchy isn't always an option (i.e. contributed tutorials, documentation of observables for a different project, etc.). If creating such a page you might want to consider adding the "Data Binding" category to the page.

[edit] Category

Any page related to the concept of data binding in general should be added to the Data Binding category. To do this add the following to the article...

 [[Category:Data Binding]]

The category will allow for documents that aren't necessarilly part of the core documentation, or part of the article hierarchy, to be aggregated.

[edit] Side Bar

On some of the JFace Data Binding pages you'll see a side bar on the top right. This is done with the JFace Data Binding Template.

{{JFace Data Binding}}

The recommendation is to put this towards the top of the page. It is provided so that we can create a feeling of a site within our documentation.