Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

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

 
(9 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, as if the page already existed. Click on the '''Edit '''link to open the Rich Editor. <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'''.&nbsp; <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>
  
<br>You can set code examples to monospace by clicking '''WikiText''' and using the following tags:  
+
==== <br>To include code snippets:<br>  ====
  
*For inline examples such as <code>x = y</code>, use this tagging:<br>&nbsp;&nbsp;&nbsp;such as '''&lt;code&gt;'''x = y'''&lt;/code&gt;''' <br>
+
You can set code examples to monospace by clicking '''WikiText''' and then using the following tags:  
*For larger examples, use this tagging:
+
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'''&lt;pre&gt;<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'''x = y;
+
*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>  
  
&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>
+
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.
  
<br>You can copy content and markup from one section to another only by working in Wikitext or outside the Rich Editor.<br><br>To learn more about editing&nbsp;Wiki pages:  
+
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.
 +
 
 +
==== <br><br><br>To learn more about editing&nbsp;Wiki pages: ====
  
 
*[http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki Markup]  
 
*[http://en.wikipedia.org/wiki/Help:Wiki_markup Wiki Markup]  

Latest revision as of 15:03, 6 March 2012

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. 


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.




To learn more about editing Wiki pages:

Copyright © Eclipse Foundation, Inc. All Rights Reserved.