Difference between revisions of "EDT:How to Create/Edit Wiki pages"

From Eclipsepedia

Jump to: navigation, search
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
To make a new page:  
+
==== To create a new page: ====
  
#Enter a&nbsp;new URL in your browser and include the "EDT:" prefix. For example, http://wiki.eclipse.org/'''EDT:'''My_New_page. <br><br>You'll be told that there's no text in the page yet, as if the page already existed but was blank. Click on the '''Edit '''link and write your masterpiece.&nbsp; <br>
+
#Enter a new URL in your browser and include the "EDT:" prefix. For example, wiki.eclipse.org/'''EDT:'''MyNewPage. <br>You'll be told that there's no text in the page. Click on the '''Edit this page''' link or the Edit tab. <br>  
#Click '''Wikitext'''. <br>
+
#Using the Wikitext editor (click on Wikitext in the toolbar), place this line at the bottom of your page (with double brackets)<br><nowiki>&nbsp;&nbsp;&nbsp;&nbsp; [[Category:EDT]]</nowiki><br>The category may not display correctly until you save your work.&nbsp; <br>
#Place the following detail at the bottom of your page, with double left brackets in front and double right brackets in back:&nbsp;&nbsp;<br><br>&nbsp;&nbsp;&nbsp;&nbsp; EDT:Category <br>
+
#To return to the Rich Editor, click '''Wikitext''' again.&nbsp; You might not see the category displayed correctly until you save your work.
+
  
<br>Doing steps 2-3 causes the following page&nbsp;to include&nbsp;your contribution:&nbsp; [[:Category:EDT]].  
+
Marking the page causes includes your contribution on the [[:Category:EDT|Category:EDT]] page. This way we can make sure pages are appropriately included in the sidebar navigation of the wiki.&nbsp; <br>
  
To learn about editing the Wiki pages:  
+
==== <br>To include code snippets:<br>  ====
  
*[http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki Markup]
+
You can set code examples to monospace by clicking '''WikiText''' and then using the following tags:  
*[http://en.wikipedia.org/wiki/Wikipedia:Tutorial Wikipedia Tutorial]
+
*[http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet]
+
*[http://wiki.eclipse.org/Eclipse_Doc_Style_Guide Eclipse Doc Style Guide]
+
  
<br>Note that you can set code examples to monospace by clicking '''WikiText''' and using the following tags:
+
*For inline examples such as <source lang="java">x = y</source> use this tagging:<br>&nbsp;&nbsp;&nbsp;'''&lt;source&gt;'''x = y'''&lt;/source&gt;''' <br>
  
*For inline examples such as x = y, use this tagging:<br><br>&nbsp;&nbsp;&nbsp;&nbsp; such as &lt;code&gt;<code>x = y&lt;/code&gt;</code>
+
The &lt;source&gt; tag is used instead of &lt;code&gt; or &lt;pre&gt; since it provides syntax highlighting similar to an advanced source code editor. We use the Java language highlighting, since one doesn't exist (yet) for EGL. If you are interested in writing a syntax highlighter for EGL, the GeSHi (Generic Syntax Highlighter) extension is used.
  
For larger examples, use this tagging:
+
You can spend a lot of trying to create complex formatting, but the wiki is imperfect. For example, you cannot create multiple lines of code under a bullet or number (or at least not easily), and it seems impossible to create multiple lines of code under a second-level bullet.
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;pre&gt;
+
==== <br><br><br>To learn more about editing&nbsp;Wiki pages:  ====
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; x = y;
+
*[http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki Markup]
 
+
*[http://en.wikipedia.org/wiki/Wikipedia:Tutorial Wikipedia Tutorial]
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; y = z;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &lt;/pre&gt;<br>
+
*[http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet Wikipedia Cheatsheet]
 +
*[http://wiki.eclipse.org/Eclipse_Doc_Style_Guide Eclipse Doc Style Guide]
  
 
[[Category:EDT]]
 
[[Category:EDT]]

Latest revision as of 15:03, 6 March 2012

[edit] To create a new page:

  1. Enter a new URL in your browser and include the "EDT:" prefix. For example, wiki.eclipse.org/EDT:MyNewPage.
    You'll be told that there's no text in the page. Click on the Edit this page link or the Edit tab.
  2. Using the Wikitext editor (click on Wikitext in the toolbar), place this line at the bottom of your page (with double brackets)
         [[Category:EDT]]
    The category may not display correctly until you save your work. 

Marking the page causes includes your contribution on the Category:EDT page. This way we can make sure pages are appropriately included in the sidebar navigation of the wiki. 

[edit]
To include code snippets:

You can set code examples to monospace by clicking WikiText and then using the following tags:

  • For inline examples such as
    x = y
    use this tagging:
       <source>x = y</source>

The <source> tag is used instead of <code> or <pre> since it provides syntax highlighting similar to an advanced source code editor. We use the Java language highlighting, since one doesn't exist (yet) for EGL. If you are interested in writing a syntax highlighter for EGL, the GeSHi (Generic Syntax Highlighter) extension is used.

You can spend a lot of trying to create complex formatting, but the wiki is imperfect. For example, you cannot create multiple lines of code under a bullet or number (or at least not easily), and it seems impossible to create multiple lines of code under a second-level bullet.

[edit]


To learn more about editing Wiki pages: