Difference between revisions of "Stardust/Formatting Guidelines"

From Eclipsepedia

Jump to: navigation, search
m
 
(9 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
== Deciding on a new Page Location  ==
 
== Deciding on a new Page Location  ==
  
A new page should be added under URL, Stardust/Knowledge_Base/Topic_Name&gt;/Nice_Page_Name<br>Where, topic can be any main item listed on knowledge base home page like Getting Started, Customization, Embedded Usage, Security. etc.  
+
A new page should be added under URL, Stardust/KnowledgeBase/&lt;topic&gt;/new_page<br>Where, topic can be any main item listed on knowledge base home page like Getting Started, Customization, Embedded Usage, or Security.  
  
Please do not use spaces but underscores ( _ ) to create nice page names in natural writing. However, please also try to keep the name short. The page name will server as teh page title, no additonal title(repetition) should be used (would show up in TOC).<br>
+
You may have sub-topics under main topic. For example, ‘SSO and Secure Communication with Stardust using Kerberos’ article is added at this relative URL;<br>&nbsp;/Stardust/KnowledgeBase/Security/SSO/SSO_and_Secure_Communication_with_IPP_using_Kerberos.
  
You may have sub-topics under main topic. For example, ‘SSO and Secure Communication with Stardust using Kerberos’ article is added at this relative URL;<br>Stardust/Knowledge_Base/Security/SSO/SSO_and_Secure_Communication_with_IPP_using_Kerberos.
+
<br>
 
+
If a deper hierarchy is used then overview pages listing sub items should exist on all levels. Otherwise the breadcrumbs on the top of the page will not display properly.
+
 
+
<br>  
+
  
 
== Adding a new Page  ==
 
== Adding a new Page  ==
Line 18: Line 14:
  
 
*from knowledge base home page, browse to the category under which you want to add a new page;  
 
*from knowledge base home page, browse to the category under which you want to add a new page;  
*now, in browser URL, append a forward slash (/) followed by a new page title (use _ instead of blanks) and hit the enter key;  
+
*now, in browser URL, append a forward slash (/) followed by a new page title and hit the enter key;  
 
*the wiki will display that there is currently no text in this page, and if you wish to edit and create a new page, you may click on ‘edit this page’ option; and  
 
*the wiki will display that there is currently no text in this page, and if you wish to edit and create a new page, you may click on ‘edit this page’ option; and  
 
*the wiki will open the page editor, and you may add content and save the page.
 
*the wiki will open the page editor, and you may add content and save the page.
Line 27: Line 23:
  
 
*Use the "[http://en.wikipedia.org/wiki/Letter_case#Headings_and_publication_titles all nouns]" style for titles and page headings: Capitalize all nouns and nouns only. Do not capitalize articles, prepositions, conjunctions, and forms of to be.  
 
*Use the "[http://en.wikipedia.org/wiki/Letter_case#Headings_and_publication_titles all nouns]" style for titles and page headings: Capitalize all nouns and nouns only. Do not capitalize articles, prepositions, conjunctions, and forms of to be.  
*Do not repeat the title on the page but instead use a well readable page location/name that uses "_" as Blanks and follows the "all nouns" capitalization rules.  
+
*If you wish to give a title to the page, use 'Heading 1' formatting.  
 
*For all first class headings (level1) in your page, use the 'Heading 2' formatting.  
 
*For all first class headings (level1) in your page, use the 'Heading 2' formatting.  
 
*For sub-headings under level1 heading, use 'Heading 4' and reduce headers down as per your need.  
 
*For sub-headings under level1 heading, use 'Heading 4' and reduce headers down as per your need.  
*Note that by default all page headers appear in the table of contents section at the top. So if you want to highlight text in the page, use bold, italics or underline formating.  
+
*Note that by default all page headers appear in the table of contents section at the top. So if you want to highlight text in the page, use bold, italics or underline formatting.  
 
*For normal paragraph text, use 'Normal' formatting option.<br>  
 
*For normal paragraph text, use 'Normal' formatting option.<br>  
*Do not prefix hedings with numerations. Those will be added automatically in the table of contents and adding them will double the numeration<br>  
+
*Do not prefix headings with numerations. Those will be added automatically in the table of contents and adding them will double the numeration<br>  
*Do not use dots or collons at the end of a title or heading
+
*Do not use dots or colons at the end of a title or heading
  
 
<br>
 
<br>
  
== XML, SQL and Source Formating ==
+
== XML, SQL and Source Formatting ==
  
 
Use the tag <source lang="XML"><source lang="..."></source> to formatting XML, SQL or code snippets. The value of the ‘lang’ attribute can be either ‘Java’, SQL or ‘XML’.  
 
Use the tag <source lang="XML"><source lang="..."></source> to formatting XML, SQL or code snippets. The value of the ‘lang’ attribute can be either ‘Java’, SQL or ‘XML’.  

Latest revision as of 04:12, 25 March 2014

This page lists the formatting guidelines that should be used by all documents on the Stardust Wiki. The purpose of these guidelines is to create uniform experience to the readers.

Contents

[edit] Deciding on a new Page Location

A new page should be added under URL, Stardust/KnowledgeBase/<topic>/new_page
Where, topic can be any main item listed on knowledge base home page like Getting Started, Customization, Embedded Usage, or Security.

You may have sub-topics under main topic. For example, ‘SSO and Secure Communication with Stardust using Kerberos’ article is added at this relative URL;
 /Stardust/KnowledgeBase/Security/SSO/SSO_and_Secure_Communication_with_IPP_using_Kerberos.


[edit] Adding a new Page

To add a new page in the knowledge base, do the following:       

  • from knowledge base home page, browse to the category under which you want to add a new page;
  • now, in browser URL, append a forward slash (/) followed by a new page title and hit the enter key;
  • the wiki will display that there is currently no text in this page, and if you wish to edit and create a new page, you may click on ‘edit this page’ option; and
  • the wiki will open the page editor, and you may add content and save the page.


[edit] Page Titles, Headings and Capitalization

  • Use the "all nouns" style for titles and page headings: Capitalize all nouns and nouns only. Do not capitalize articles, prepositions, conjunctions, and forms of to be.
  • If you wish to give a title to the page, use 'Heading 1' formatting.
  • For all first class headings (level1) in your page, use the 'Heading 2' formatting.
  • For sub-headings under level1 heading, use 'Heading 4' and reduce headers down as per your need.
  • Note that by default all page headers appear in the table of contents section at the top. So if you want to highlight text in the page, use bold, italics or underline formatting.
  • For normal paragraph text, use 'Normal' formatting option.
  • Do not prefix headings with numerations. Those will be added automatically in the table of contents and adding them will double the numeration
  • Do not use dots or colons at the end of a title or heading


[edit] XML, SQL and Source Formatting

Use the tag
<source lang="...">
to formatting XML, SQL or code snippets. The value of the ‘lang’ attribute can be either ‘Java’, SQL or ‘XML’.


[edit] Linking new Pages

When we add a new page at appropriate location in wiki, by default it is not linked with any existing page. We need to explicitly add a link to this new page on either knowledge base home page or under some topic overview page.

Use bullets with page titles on overview page to link pages.


[edit] Keywords

A Table of Contents is automatically generated at the top of an article. Add the keyword __NOTOC__ on the first line of the article using the Wikitext editor to suppress the ToC.
Edit links are automatically generated on the right side of header sections. To suppress them add __NOEDITSECTION__ at the top of the article using the Wikitext editor.

Hint: Technically these keywords can be anywhere on the page, but it makes sense to keep them at the top of the page, so they are easily found.