OpenWetWare:Tidy
From OpenWetWare
(Difference between revisions)
(→Keeping things tidy (work in progress)) |
Current revision (02:27, 4 April 2008) (view source) m (User:Ricardo Vidal/workshed/tidy moved to OpenWetWare:Tidy: Basic rules to keep things tidy and organized on OWW) |
||
| (10 intermediate revisions not shown.) | |||
| Line 1: | Line 1: | ||
| - | ==Keeping things tidy ( | + | ==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 | + | ** 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>User:Bio_Engineer/ | + | :<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> | ||
* 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> | ||
| Line 20: | Line 21: | ||
==Why use such a hierarchical scheme?== | ==Why use such a hierarchical scheme?== | ||
* There are a few good reasons to use such a scheme. | * There are a few good reasons to use such a scheme. | ||
| - | *# Your URL becomes easier to remember and is directly related to you and/or your lab<br /> | + | *# Your URL becomes '''easier to remember''' and is directly related to you and/or your lab<br />[[Image:url_structure_1.jpg]] |
| - | *# You will be able to search for information contained within your hierarchical ladder of pages<br /> | + | *# You will be able to '''search''' for information contained '''within your''' hierarchical ladder of '''pages'''<br />[[Image:url_structure_2.jpg]] |
| - | *# A proper breadcrumb navigation is automatically created which allows better navigation within your namespace.<br /> | + | *# A proper '''breadcrumb navigation''' is automatically created which allows better navigation within your namespace.<br />[[Image:url_structure_3.jpg]] |
Current revision
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 assumehttp://openwetware.org/wiki/as a prefix to all the following URIs)
- Imagine my user name is Bio Engineer and therefore my user page URI is:
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:
-
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
Why use such a hierarchical scheme?
- There are a few good reasons to use such a scheme.
- Your URL becomes easier to remember and is directly related to you and/or your lab
- You will be able to search for information contained within your hierarchical ladder of pages
- A proper breadcrumb navigation is automatically created which allows better navigation within your namespace.
- Your URL becomes easier to remember and is directly related to you and/or your lab
