Difference between revisions of "Template:Office Hours/Documentation"

From Second Life Wiki
Jump to navigation Jump to search
(will add the doc tonight after i implemented the cascading)
 
(manual)
Line 1: Line 1:
<onlyinclude>Lindens: Please read [[Template:Office Hours/Documentation|this manual]] on how to add your Office Hour to the [[Office Hours]] pages</onlyinclude>
<onlyinclude><includeonly>Lindens: Please read [[Template:Office Hours/Documentation|this manual]] on how to add your Office Hour to the [[Office Hours]] pages</includeonly></onlyinclude>{{Help|noMultiLang=*|Wiki=*}}
<div id="box">
== What is this article about? ==
<div style="padding: 0.5em">
{{RightToc}}
This page is supposed to provide a manual for [[:Category:Linden_Lab_Employees|Linden Lab employees]] on how they can schedule their office hours, so they become included in the [[Office Hours]] articles as well as various [http://en.wikipedia.org/wiki/Webcal webcal] feeds and the [http://twitter.com/slOfficeHours Office Hour twitter].


<DOCUMENTATION>
On a sidenote: When you list your Office Hour in the Wiki, ''please keep the information up-to-date''! It might become frustrating for Residents who'd took the time to attend to your office hour, just to see that it's not held anymore.
<br clear="all"/>
</div></div>  


(this is upcoming)
<div id="box">
== Manual ==
<div style="padding: 0.5em">
=== How to add an Office Hour ===
In order to add your Office Hours, you'll first need to log in the Wiki. Click [[Special:UserLogin|this link]] and enter your Second Life first and last name, as well as your SL password. It is important to do this '''before''' proceeding with this manual, since some of the links presented here will only work properly when you're logged in.
 
Once you're logged in, you'll need to decide on which day(s) your Office Hour(s) should be. Depending on day and grid, open one of the following links in a new browser (tab).
 
{|
|Main Grid:
|[[Special:MyPage/Office Hours/Monday|Monday]]
|[[Special:MyPage/Office Hours/Tuesday|Tuesday]]
|[[Special:MyPage/Office Hours/Wednesday|Wednesday]]
|[[Special:MyPage/Office Hours/Thursday|Thursday]]
|[[Special:MyPage/Office Hours/Friday|Friday]]
|[[Special:MyPage/Office Hours/Saturday|Saturday]]
|[[Special:MyPage/Office Hours/Sunday|Sunday]]
|-
|Teen Grid:
|[[Special:MyPage/Teen Office Hours/Monday|Monday]]
|[[Special:MyPage/Teen Office Hours/Tuesday|Tuesday]]
|[[Special:MyPage/Teen Office Hours/Wednesday|Wednesday]]
|[[Special:MyPage/Teen Office Hours/Thursday|Thursday]]
|[[Special:MyPage/Teen Office Hours/Friday|Friday]]
|[[Special:MyPage/Teen Office Hours/Saturday|Saturday]]
|[[Special:MyPage/Teen Office Hours/Sunday|Sunday]]
|}
 
 
The Wiki will show you a page that looks like this:
 
 
<div class="noarticletext">
<p>There is currently no text in this page, you can <font color="blue"><u>search for this page title</u></font> in other pages or <font color="blue"><u>edit this page</u></font>.
</p>
</div>
 
 
Click the ''<font color="blue"><u>edit this page</u></font>'' link on that site and copy and paste the following content:
 
<nowiki>{{</nowiki>hCalendar event/Office Hours
|mode=<nowiki>{{{mode|}}}</nowiki>
|Resident=
|weekday=
|start=
|end=
|description=
|location=
}}
 
You will now need to fill in your details after the equal (<font color="black">=</font>) signs. It is important that you don't supply extra info to the <font color="black">weekday</font>, <font color="black">start</font> and <font color="black">end</font> variables, since these are used to automatically generate the webcal feeds. Here is an example mockup, in case [[User:Magellan Linden|Magellan Linden]] would want to schedule an office hour:
 
<nowiki>{{</nowiki>hCalendar event/Office Hours
|mode=<nowiki>{{{mode|}}}</nowiki>
|Resident=<font color="blue">Magellan Linden</font>
|weekday=<font color="blue">Tuesday</font>
|start=<font color="blue">10:30am PST</font>
|end=<font color="blue">11:30am PST</font>
|description=<font color="blue">Storytelling. How I found Nautilus City and what I'm up to with this Mole Tank.</font>
|location=<font color="blue"><nowiki>[http://slurl.com/secondlife/Omidyar/128/128/10 Omidyar]</nowiki></font>
}}
 
Please use this style to specify your office hours.
 
Remember that 12pm is noon, not 12am! So an office hour lasting one hour and starting at 11am would have <font color="black">start=11am</font> and <font color="black">end=12pm</font>.
 
 
=== How to embedd an Office Hour ===
Once you created the page with the method listed above, you will need to add to to the collection of Office Hours, so it becomes included in the related articles and feeds. To do so, browse to one of the following pages, depending on day and grid of your office hour.
 
{|
|Main Grid:
|[[Office Hours/Monday/MG|Monday]]
|[[Office Hours/Tuesday/MG|Tuesday]]
|[[Office Hours/Wednesday/MG|Wednesday]]
|[[Office Hours/Thursday/MG|Thursday]]
|[[Office Hours/Friday/MG|Friday]]
|[[Office Hours/Saturday/MG|Saturday]]
|[[Office Hours/Sunday/MG|Sunday]]
|-
|Teen Grid:
|[[Office Hours/Monday/TG|Monday]]
|[[Office Hours/Tuesday/TG|Tuesday]]
|[[Office Hours/Wednesday/TG|Wednesday]]
|[[Office Hours/Thursday/TG|Thursday]]
|[[Office Hours/Friday/TG|Friday]]
|[[Office Hours/Saturday/TG|Saturday]]
|[[Office Hours/Sunday/TG|Sunday]]
|}
 
You will now need to click the <font color="blue">edit</font> edit link on top of the page. You will discover that there is already code on that page and that it looks kinda ugly. Don't let that scare you away. All you will now need to do is copy and paste the following code at the end of the code which is already there. Don't create a linebreak. Just add it there after the latest entry and save your edit. The code looks like this:
 
<nowiki>{{</nowiki>Office Hours/include-by-day|<font color="blue">YOUR NAME</font>|{{{day}}}|mode={{{mode|h3}}}}}
 
with <font color="blue">YOUR NAME</font> beeing your username. For example, Magellan Linden would add his office hour with the following code:
 
<nowiki>{{</nowiki>Office Hours/include-by-day|Magellan Linden|{{{day}}}|mode={{{mode|h3}}}}}
 
When you saved it, you just successfully added your office hour :-)
 
Since the Wiki caches it's edits, it might be that your edit isn't immidiatly displayed on the [[Office Hours]] page. You can either wait some time for it to refresh it's cache, or you can force it to refresh by [https://wiki.secondlife.com/wiki/Office_Hours?action=purge pressing this link]. This will purge the cache and your office hour will be visible at the table.
 
 
'''optional:'''
 
You can give residents the chance to subscribe to ''just'' your Office Hours via a webcal, instead of subscribing to the feed which involves all Lindens. All you need to do is, browse to [[Special:MyPage/Office Hours]] and add the following code:
 
<nowiki><noinclude>{{Office Hours/Userpage‎}}</noinclude></nowiki>
 
Save the page and you are done :-)
 
=== How to remove an Office Hour ===
In order to remove your Office Hour, you just need to browse to the subpage of your userpage again where you listet your Office Hour an '''remove all content from there'''. Do not write something like "''Canceled''" or "''Removed''" or anything similar, but make sure to remove all content. It would break the style of the Office Hour page otherwise. However, you can of course leave a note at [[Special:MyPage/Office Hours]]. But don't leave anything on the subpage of that. Here are the links again, in case you lost them:
{|
|Main Grid:
|[[Special:MyPage/Office Hours/Monday|Monday]]
|[[Special:MyPage/Office Hours/Tuesday|Tuesday]]
|[[Special:MyPage/Office Hours/Wednesday|Wednesday]]
|[[Special:MyPage/Office Hours/Thursday|Thursday]]
|[[Special:MyPage/Office Hours/Friday|Friday]]
|[[Special:MyPage/Office Hours/Saturday|Saturday]]
|[[Special:MyPage/Office Hours/Sunday|Sunday]]
|-
|Teen Grid:
|[[Special:MyPage/Teen Office Hours/Monday|Monday]]
|[[Special:MyPage/Teen Office Hours/Tuesday|Tuesday]]
|[[Special:MyPage/Teen Office Hours/Wednesday|Wednesday]]
|[[Special:MyPage/Teen Office Hours/Thursday|Thursday]]
|[[Special:MyPage/Teen Office Hours/Friday|Friday]]
|[[Special:MyPage/Teen Office Hours/Saturday|Saturday]]
|[[Special:MyPage/Teen Office Hours/Sunday|Sunday]]
|}
 
You do not need to go to the ugly looking other page in order to remove it there as well. It won't harm there.
</div></div>
 
<div id="box">
== Related Links ==
<div style="padding: 0.5em">
*[[Quickie Wiki Intro]]
*[[:Category:Help/Wiki]]
</div></div>

Revision as of 20:17, 18 February 2009

What is this article about?

This page is supposed to provide a manual for Linden Lab employees on how they can schedule their office hours, so they become included in the Office Hours articles as well as various webcal feeds and the Office Hour twitter.

On a sidenote: When you list your Office Hour in the Wiki, please keep the information up-to-date! It might become frustrating for Residents who'd took the time to attend to your office hour, just to see that it's not held anymore.

Manual

How to add an Office Hour

In order to add your Office Hours, you'll first need to log in the Wiki. Click this link and enter your Second Life first and last name, as well as your SL password. It is important to do this before proceeding with this manual, since some of the links presented here will only work properly when you're logged in.

Once you're logged in, you'll need to decide on which day(s) your Office Hour(s) should be. Depending on day and grid, open one of the following links in a new browser (tab).

Main Grid: Monday Tuesday Wednesday Thursday Friday Saturday Sunday
Teen Grid: Monday Tuesday Wednesday Thursday Friday Saturday Sunday


The Wiki will show you a page that looks like this:


There is currently no text in this page, you can search for this page title in other pages or edit this page.


Click the edit this page link on that site and copy and paste the following content:

{{hCalendar event/Office Hours
|mode={{{mode|}}}
|Resident=
|weekday=
|start=
|end=
|description=
|location=
}}

You will now need to fill in your details after the equal (=) signs. It is important that you don't supply extra info to the weekday, start and end variables, since these are used to automatically generate the webcal feeds. Here is an example mockup, in case Magellan Linden would want to schedule an office hour:

{{hCalendar event/Office Hours
|mode={{{mode|}}}
|Resident=Magellan Linden
|weekday=Tuesday
|start=10:30am PST
|end=11:30am PST
|description=Storytelling. How I found Nautilus City and what I'm up to with this Mole Tank.
|location=[http://slurl.com/secondlife/Omidyar/128/128/10 Omidyar]
}}

Please use this style to specify your office hours.

Remember that 12pm is noon, not 12am! So an office hour lasting one hour and starting at 11am would have start=11am and end=12pm.


How to embedd an Office Hour

Once you created the page with the method listed above, you will need to add to to the collection of Office Hours, so it becomes included in the related articles and feeds. To do so, browse to one of the following pages, depending on day and grid of your office hour.

Main Grid: Monday Tuesday Wednesday Thursday Friday Saturday Sunday
Teen Grid: Monday Tuesday Wednesday Thursday Friday Saturday Sunday

You will now need to click the edit edit link on top of the page. You will discover that there is already code on that page and that it looks kinda ugly. Don't let that scare you away. All you will now need to do is copy and paste the following code at the end of the code which is already there. Don't create a linebreak. Just add it there after the latest entry and save your edit. The code looks like this:

{{Office Hours/include-by-day|YOUR NAME|{{{day}}}|mode=h3}}

with YOUR NAME beeing your username. For example, Magellan Linden would add his office hour with the following code:

{{Office Hours/include-by-day|Magellan Linden|{{{day}}}|mode=h3}}

When you saved it, you just successfully added your office hour :-)

Since the Wiki caches it's edits, it might be that your edit isn't immidiatly displayed on the Office Hours page. You can either wait some time for it to refresh it's cache, or you can force it to refresh by pressing this link. This will purge the cache and your office hour will be visible at the table.


optional:

You can give residents the chance to subscribe to just your Office Hours via a webcal, instead of subscribing to the feed which involves all Lindens. All you need to do is, browse to Special:MyPage/Office Hours and add the following code:

<noinclude>{{Office Hours/Userpage‎}}</noinclude>

Save the page and you are done :-)

How to remove an Office Hour

In order to remove your Office Hour, you just need to browse to the subpage of your userpage again where you listet your Office Hour an remove all content from there. Do not write something like "Canceled" or "Removed" or anything similar, but make sure to remove all content. It would break the style of the Office Hour page otherwise. However, you can of course leave a note at Special:MyPage/Office Hours. But don't leave anything on the subpage of that. Here are the links again, in case you lost them:

Main Grid: Monday Tuesday Wednesday Thursday Friday Saturday Sunday
Teen Grid: Monday Tuesday Wednesday Thursday Friday Saturday Sunday

You do not need to go to the ugly looking other page in order to remove it there as well. It won't harm there.