Differences

This shows you the differences between two versions of the page.

--- wiki:sidebars [2007/08/23 16:26] – jas
+++ wiki:sidebars [2007/08/24 08:31] (current) – jas
@@ Line 9: / Line 9: @@
 ===== Wiki Name =====
-The Wiki Name is displayed under the Department Name.  This is the name that you provided to tech in your request for a wiki.
+The Wiki Name is displayed under the Department name.  This is the name that you provided to tech in your request for a Wiki.
-If you click on the Wiki name, you will always be returned to the main page of your site.  If you decide to change the Wiki name, follow these steps:
+If you click on the Wiki name, you will always be returned to the main page of your site.  If you decide to change your Wiki name, follow these steps:
   * Select the "Admin" button.
@@ Line 21: / Line 21: @@
 The sidebar contains links to other Wiki pages.  These links can appear at the left margin (level 1), or at increased indent (level 2 through 5).
-Sidebar links will only be displayed to users who have read access to those links.  This means the your sidebar will adapt depending on who is logged in.  Links to external sites will always be displayed in the sidebar.
+Sidebar links will only be displayed to users who have read access to those links.  This means that your sidebar will change depending on who is logged in.  Links to external sites will always be displayed in the sidebar.
 ===== Edit Buttons =====
-The sidebar is contained in the <code>sidebar</code> Wiki page in the root namespace.  When you wish to edit the sidebar, you can use the "Edit" button that appears below the sidebar links when you are logged in as an admin.
+The sidebar is contained in the //sidebar// Wiki page in the root namespace.  To edit the sidebar, use the "Edit" button that appears below the sidebar links when you are logged in as an admin.
 ==== Sidebar Syntax ====
@@ Line 32: / Line 32: @@
   <sidebar>
-    <item [ns="#NAMESPACE"] [level="#"] link="LINK">[description]</item>
+    <item [ns="name"] [level="#"] link="link">[description]</item>
   </sidebar>
-Your sidebar file must start and end with the ''<sidebar>'' and ''</sidebar>'' tags respectively.
+The sidebar page must start and end with the ''<sidebar>'' and ''</sidebar>'' tags respectively.  In between these tags, you will list sidebar entries in between ''<item>'' and ''</item>'' tags.  There are several attributes that you may specify - namespace, level, link, and description.
-Next, you may optionally specify a namespace (ns).  This namespace indicates where your sidebar will be displayed.  If you do not specify an ns, your sidebar entry will be displayed in all namespaces.  ns can be used along with the link level to allow you to create sidebar entries that only display when you are in a certain namespace.
+The //ns// attribute allows you to specify under which namespace your sidebar entry will be displayed.  If you do not add the //ns// attribute to your sidebar entry, this entry will be displayed when the user is in any namespace.
-Next, you can optionally specify a link level.  If this will be a level 1 link (appearing at the left margin), then you need not specify a level at all.  If this will be a level 2 link, use ''level="2"''.
+The //level// attribute allows you to specify an indent level for your sidebar entry.  level can be from 1-5.  If you do not add the //level// attribute to your sidebar entry, this entry will appear at level 1 (left margin of sidebar).  As you increase the level, the indent will increase as well.  You can use the //level// attribute along with the //ns// attribute to display submenus.
-Next, specify the link name.  For a simple sidebar, this is the only required field.  The link can be an internal wiki link like ''a:b:'' or an external link like ''http://www.cse.yorku.ca''.
+The //link// attribute allows you to specify the link for a sidebar entry.  This is the only required attribute.  The link can be an internal wiki link like ''a:b:'' or an external link like ''http://www.cse.yorku.ca''.
-Next, you can specify an optional description.  By default, if you are linking to an internal DokuWiki page, the Wiki will use the first heading tag on the page of the document as the description.
+//description// is the value of the ''item'' node for a sidebar entry.   This is what the user sees in the sidebar.  If you do not specify a description, the Wiki will use the first heading on the destination page as the description.
-Note that the arguments to the item tag can be specified in any order.
+The attributes to the item tag can be specified in any order.
-**Warning: If you use an & in your sidebar, you MUST use the valid XML syntax of <code>&amp;</code> otherwise your entire sidebar will not display.**
+<box red>
+If you use an & in your sidebar, you MUST use the valid XML syntax of ''&amp;'' otherwise your entire sidebar will not display.
+</box>
 Now let's see a few examples!
-A simple :sidebar with 2 level 1 entries:
+Here is a simple sidebar with 2 level 1 entries - Contact, and Assignments:
   <sidebar>
@@ Line 58: / Line 60: @@
   </sidebar>
-Now, let's say that when the user clicks on "Assignments", you wish to open up a second level in the sidebar showing "Assignment 1", and "Assignment 2".  Note how the sidebar will display the level 2 entries when in the "assignment" namespace:
+Now, let's say that when the user clicks on "Assignments", you wish to open up a second level in the sidebar showing "Assignment 1", and "Assignment 2" indented underneath "Assignments":
   <sidebar>
@@ Line 66: / Line 68: @@
     <item ns="assignments" level="2" link=":assignments:a2:">Assignment 2</item>
   </sidebar>
-Please note that if you view a sidebar file through the wiki engine, it will display the entire file on one line because this is how the Wiki "renders" the sidebar.  The sidebar will display correctly at the side of the screen or through the edit interface.
 ===== Search =====
-The search area on the sidebar allows you to search through your wiki site.  The search is local to your Wiki site only.
+The search area on the sidebar allows you to search through your Wiki site.  The search is local to your Wiki site only.
 ===== York Logo =====