Difference between revisions of "OpenWetWare:Tidy"

From OpenWetWare
Jump to: navigation, search
(Why use such a hierarchical scheme?)
m (User:Ricardo Vidal/workshed/tidy moved to OpenWetWare:Tidy: Basic rules to keep things tidy and organized on OWW)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Keeping things tidy (work in progress)==
+
==Keeping things tidy (hierarchical structured pages)==
 
* Aside from the necessary [[Etiquette|etiquette]], users should try keep their pages as tidy as possible. Not only the content within the pages, but also the ''location'' of said pages.
 
* Aside from the necessary [[Etiquette|etiquette]], users should try keep their pages as tidy as possible. Not only the content within the pages, but also the ''location'' of said pages.
  
 
* Here's an example:
 
* Here's an example:
**Imagine my user name is '''Bio Engineer''' and therefore my user page URI is:<br /><span class="mygreycomments">(Please assume http://openwetware.org/wiki/ as a prefix to all the following URIs)</span>
+
**Imagine my user name is '''Bio Engineer''' and therefore my user page URI is:<br /><span class="mygreycomments">(Please assume <code><nowiki>http://openwetware.org/wiki/</nowiki></code> as a prefix to all the following URIs)</span>
 
:<pre>User:Bio_Engineer</pre>This address is my User Page where I'll place all my up-to-date information and also all the links to pages that I create or that I think others might find interesting related to me and my work (in or outside the wiki).
 
:<pre>User:Bio_Engineer</pre>This address is my User Page where I'll place all my up-to-date information and also all the links to pages that I create or that I think others might find interesting related to me and my work (in or outside the wiki).
** Pages that I create should remain within my namespace and not elsewhere (unless they belong to another namespace like a lab or a group. So, I create this page for this cool new idea I have and I place it within my namespace, like so:
+
** Pages that I create should remain within my namespace and not elsewhere (unless they belong to another namespace like a lab or a group). So, I want to create a page for this cool new idea I have and therefore I edit my User page by clicking on the edit tab (at the top of the page) and inserting the following:
 +
:<pre>[[/Cool idea|My cool idea]]</pre>
 +
:Note the '''/'''. This will create a link to your new Cool idea page within your current page. Do your best to keep within the [[Help:Page_naming_conventions|page naming conventions]].
 
:<pre>User:Bio_Engineer/Cool_idea</pre>
 
:<pre>User:Bio_Engineer/Cool_idea</pre>
 
 
* In a nutshell, you end up with something similar to this:
 
* In a nutshell, you end up with something similar to this:
 
: <html><pre>
 
: <html><pre>

Latest revision as of 23:27, 3 April 2008

Keeping things tidy (hierarchical structured pages)

  • Aside from the necessary etiquette, users should try keep their pages as tidy as possible. Not only the content within the pages, but also the location of said pages.
  • Here's an example:
    • Imagine my user name is Bio Engineer and therefore my user page URI is:
      (Please assume http://openwetware.org/wiki/ as a prefix to all the following URIs)
User:Bio_Engineer
This address is my User Page where I'll place all my up-to-date information and also all the links to pages that I create or that I think others might find interesting related to me and my work (in or outside the wiki).
    • Pages that I create should remain within my namespace and not elsewhere (unless they belong to another namespace like a lab or a group). So, I want to create a page for this cool new idea I have and therefore I edit my User page by clicking on the edit tab (at the top of the page) and inserting the following:
[[/Cool idea|My cool idea]]
Note the /. This will create a link to your new Cool idea page within your current page. Do your best to keep within the page naming conventions.
User:Bio_Engineer/Cool_idea
  • In a nutshell, you end up with something similar to this:
<html><pre>

User:Bio_Engineer |- User:Bio_Engineer/Page_1

|- User:Bio_Engineer/Page_1/Subpage_1a

|- User:Bio_Engineer/Page_2

|- User:Bio_Engineer/Page_2/Subpage_2a
|- User:Bio_Engineer/Page_2/Subpage_2b </pre>

</html>

Why use such a hierarchical scheme?

  • There are a few good reasons to use such a scheme.
    1. Your URL becomes easier to remember and is directly related to you and/or your lab
      Url structure 1.jpg
    2. You will be able to search for information contained within your hierarchical ladder of pages
      Url structure 2.jpg
    3. A proper breadcrumb navigation is automatically created which allows better navigation within your namespace.
      Url structure 3.jpg