Difference between revisions of "Template:LogList"

From Masq
m
m
 
(31 intermediate revisions by one user not shown)
Line 1: Line 1:
<includeonly>{{#vardefine: the_date|{{#ifeq:{{uc:{{{date_style}}}}}|RL|RL|IC}}}}
+
<includeonly>{{#dplvar:set|date_type|{{#ifeq:{{uc:{{{date_style}}}}}|RL|RL|IC}}}}
{{#ifeq:{{{explain_date}}}|yes|<center>''-= Dates are {{#var:the_date}} =-''</center>|}}{{#fornumargs: startkey
+
{{#ifeq:{{lc:{{{explain_date}}}}}|yes|<center>''-= Dates are {{#dplvar:date_type}} =-''</center>|}}<table class="sortable" id="presort_adv"><tr style="display:none;"><th data-sort-type="date" {{#ifeq:{{lc:{{{reverse}}}}}|yes|id="reverse"|}}></th><th class="unsortable"></th></tr>
 +
{{#fornumargs: startkey
 
|startvalue
 
|startvalue
|{{#vardefine:key|{{#explode:{{#var:startvalue}}|~|0}}}}{{#vardefine:value|{{#explode:{{#var:startvalue}}|~|1}}}}
+
|{{#dplvar:set|key|{{#explode:{{#var:startvalue}}|~|0}}}}{{#dplvar:set|value|{{#explode:{{#var:startvalue}}|~|1}}}}
{{#switch: {{#var: key }}
+
{{#switch: {{#dplvar: key}}
 
| the_log=
 
| the_log=
{{#vardefine: plain_name | {{#sub:{{#var: value}}|2|-2}} }}
+
{{#dplvar:set|plain_name | {{#sub:{{#dplvar: value}}|2|-2}}}}
{{#vardefine: the_title|None.}}
+
{{#dplvar:set|the_title|None.}}
{{#vardefine: the_desc|None.}}
+
{{#dplvar:set|the_desc|None.}}
 
| my_title=
 
| my_title=
{{#vardefine: the_title|{{#var:value}}}}
+
{{#dplvar:set|the_title|{{#dplvar:value}}}}
 
| description=
 
| description=
{{#vardefine: the_desc|{{#var:value}}}}
+
{{#dplvar:set|the_desc|{{#dplvar:value}}}}
{{ #dpl:  
+
{{#dplvar:set|the_date|
 +
{{#dpl:  
 
| namespace=
 
| namespace=
| titlematch={{#var:plain_name}}
+
| titlematch={{#dplvar:plain_name}}
 
| replaceintitle=/^.*?\s-\s/,
 
| replaceintitle=/^.*?\s-\s/,
 
| category=Log
 
| category=Log
| include={{#ifeq:{{#var:the_date}}|RL|{log}:rl_date|{log}:ic_date}}
+
| include={{#ifeq:{{#dplvar:date_type}}|RL|{log}:rl_date|{log}:ic_date}}
| format= ,,: [[%PAGE%|{{#ifeq:{{#var:the_title}}|None.|%TITLE%|{{#var:the_title}}}}]]<br />,<div style="padding-left: 2.75em; margin-top:-.5em; font-style:italic;">\n{{#var:the_desc}}\n</div>
+
| format=,,,
 
| secseparators=
 
| secseparators=
 
| noresultsheader=Nothing to see here.
 
| noresultsheader=Nothing to see here.
}}{{#vardefine: the_date|{{#ifeq:{{uc:{{{date_style}}}}}|RL|RL|IC}}}}
+
}}}}
 +
<tr><td style="display:none;">{{#dplvar:the_date}}</td>
 +
<td><span {{#if:{{{dateclass}}}| class="{{{dateclass}}}"}}>{{#dplvar:the_date}}:</span> [[{{#dplvar:plain_name}}|{{#ifeq:{{#dplvar:the_title}}|None.|{{#regex:{{#regex:{{#dplvar:plain_name}}|%^.*\-(.*)$%|$1}}|/_/|&nbsp;}}|{{#dplvar:the_title}}}}]]<br /><div class="logdesc">{{#dplvar:the_desc}}</div></td></tr>
 
}}
 
}}
}}{{#vardefine:logLevel|Adv}}
+
}}
 +
</table>
 
</includeonly><noinclude>== Usage ==
 
</includeonly><noinclude>== Usage ==
 
<pre>
 
<pre>
Line 29: Line 34:
 
|date_style=RL/IC
 
|date_style=RL/IC
 
|explain_date=yes/no
 
|explain_date=yes/no
 +
|reverse=yes/no
 
|-------------------
 
|-------------------
 
|the_log~Link to page name
 
|the_log~Link to page name
Line 36: Line 42:
 
</pre>
 
</pre>
  
This is a helper template to format AdvLog pages.
+
This is a helper template to format AdvLog pages and sort them automagically.
  
 
=== Examples ===
 
=== Examples ===
 
<pre>
 
<pre>
 
{{LogList
 
{{LogList
 +
|date_style=RL
 +
|explain_date=yes
 +
|reverse=yes
 +
|-------------------
 
|the_log~[[Jai - Sugar Lumps]]
 
|the_log~[[Jai - Sugar Lumps]]
 
|description~When you party with the party prince, you get two complimentary after-dinner mints.
 
|description~When you party with the party prince, you get two complimentary after-dinner mints.
 
|the_log~[[Jai - Fork In The Road]]
 
|the_log~[[Jai - Fork In The Road]]
 +
|my_title~This Is The Title I Prefer
 
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
 
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
 
}}
 
}}
 
</pre>
 
</pre>
The basic use, giving you:
+
 
 +
The optional elements include 'my_title', which should be inserted only for each log whose title you want to change on your page, and three special options above the line, 'date_style', 'explain_date', and 'reverse'.  (For some reason, 'reverse' isn't working on this page.  It's working where it matters, though.)
 +
 
 
{{LogList
 
{{LogList
 +
|date_style=RL
 +
|explain_date=yes
 +
|reverse=yes
 +
|-------------------
 
|the_log~[[Jai - Sugar Lumps]]
 
|the_log~[[Jai - Sugar Lumps]]
 
|description~When you party with the party prince, you get two complimentary after-dinner mints.
 
|description~When you party with the party prince, you get two complimentary after-dinner mints.
 
|the_log~[[Jai - Fork In The Road]]
 
|the_log~[[Jai - Fork In The Road]]
 +
|my_title~This Is The Title I Prefer
 
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
 
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
 
}}
 
}}
The optional elements include 'my_title', which should be inserted only for each log whose title you want to change on your page, and two special options above the line, 'date_style' and 'explain_date'. 
 
 
 
<pre>
 
<pre>
 
{{LogList
 
{{LogList
|date_style=RL
 
|explain_date=yes
 
|-------------------
 
 
|the_log~[[Jai - Sugar Lumps]]
 
|the_log~[[Jai - Sugar Lumps]]
 
|description~When you party with the party prince, you get two complimentary after-dinner mints.
 
|description~When you party with the party prince, you get two complimentary after-dinner mints.
 
|the_log~[[Jai - Fork In The Road]]
 
|the_log~[[Jai - Fork In The Road]]
|my_title~This Is The Title I Prefer
 
 
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
 
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
 
}}
 
}}
 
</pre>
 
</pre>
 
+
This is the most basic use, giving you:
 
+
 
{{LogList
 
{{LogList
|date_style=RL
 
|explain_date=yes
 
|-------------------
 
 
|the_log~[[Jai - Sugar Lumps]]
 
|the_log~[[Jai - Sugar Lumps]]
 
|description~When you party with the party prince, you get two complimentary after-dinner mints.
 
|description~When you party with the party prince, you get two complimentary after-dinner mints.
 
|the_log~[[Jai - Fork In The Road]]
 
|the_log~[[Jai - Fork In The Road]]
|my_title~This Is The Title I Prefer
 
 
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
 
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
 
}}
 
}}
Line 83: Line 90:
 
This template is slightly trickier to use than most.   
 
This template is slightly trickier to use than most.   
 
* You only need one instance of this template in your AdvLog page.   
 
* You only need one instance of this template in your AdvLog page.   
* Each log in your list takes a "the_log", a optional "my_title", and a "description".   
+
* Each log in your list takes a "the_log", an optional "my_title", and a "description".   
 
**They need to be in order (the_log, my_title if used, description) and please note that the repeated parameters are set off by a ~, '''not''' a =.  If you don't do it this way, it won't work!   
 
**They need to be in order (the_log, my_title if used, description) and please note that the repeated parameters are set off by a ~, '''not''' a =.  If you don't do it this way, it won't work!   
** Using a ~ in any of your log names/titles/description will also not work as expected.  
+
** Using a ~ or an = in any of your log names/titles/description will also not work as expected.  
 
* The optional parameters above the dashed line '''DO''' use an equals sign, however.   
 
* The optional parameters above the dashed line '''DO''' use an equals sign, however.   
** If you leave out these parameters, the default behaviour is to use IC dates and not give the date explanation line.
+
** If you leave out these parameters, the default behaviour is to use IC dates, not give the date explanation line, and display your logs from oldest to newest.
 +
** These parameters are independent of each other; you can freely use IC dates and explain it, use RL and not explain it, reverse the order and explain the date, or whatever combination you like.
  
 
If you find yourself confused, check (but don't change) [[Jai/AdvLog]], where you can see this in use.
 
If you find yourself confused, check (but don't change) [[Jai/AdvLog]], where you can see this in use.
 
[[Category: Templates]]</noinclude>
 
[[Category: Templates]]</noinclude>

Latest revision as of 08:17, 9 March 2013

Usage

{{LogList
|date_style=RL/IC
|explain_date=yes/no
|reverse=yes/no
|-------------------
|the_log~Link to page name
|my_title~Title you'd prefer to use, if not the default
|description~Your description of the scene.
}}

This is a helper template to format AdvLog pages and sort them automagically.

[edit] Examples

{{LogList
|date_style=RL
|explain_date=yes
|reverse=yes
|-------------------
|the_log~[[Jai - Sugar Lumps]]
|description~When you party with the party prince, you get two complimentary after-dinner mints.
|the_log~[[Jai - Fork In The Road]]
|my_title~This Is The Title I Prefer
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
}}

The optional elements include 'my_title', which should be inserted only for each log whose title you want to change on your page, and three special options above the line, 'date_style', 'explain_date', and 'reverse'. (For some reason, 'reverse' isn't working on this page. It's working where it matters, though.)


-= Dates are RL =-
10/21/2010 10/21/2010: Sugar Lumps
When you party with the party prince, you get two complimentary after-dinner mints.
11/23/2011 11/23/2011: This Is The Title I Prefer
In which Petra presents Jai with a decent proposal, for a change.
{{LogList
|the_log~[[Jai - Sugar Lumps]]
|description~When you party with the party prince, you get two complimentary after-dinner mints.
|the_log~[[Jai - Fork In The Road]]
|description~In which Petra presents Jai with a '''decent''' proposal, for a change.
}}

This is the most basic use, giving you:

01/23/2008 01/23/2008: Sugar Lumps
When you party with the party prince, you get two complimentary after-dinner mints.
09/12/2009 09/12/2009: Fork In The Road
In which Petra presents Jai with a decent proposal, for a change.

[edit] More Explanation

This template is slightly trickier to use than most.

  • You only need one instance of this template in your AdvLog page.
  • Each log in your list takes a "the_log", an optional "my_title", and a "description".
    • They need to be in order (the_log, my_title if used, description) and please note that the repeated parameters are set off by a ~, not a =. If you don't do it this way, it won't work!
    • Using a ~ or an = in any of your log names/titles/description will also not work as expected.
  • The optional parameters above the dashed line DO use an equals sign, however.
    • If you leave out these parameters, the default behaviour is to use IC dates, not give the date explanation line, and display your logs from oldest to newest.
    • These parameters are independent of each other; you can freely use IC dates and explain it, use RL and not explain it, reverse the order and explain the date, or whatever combination you like.

If you find yourself confused, check (but don't change) Jai/AdvLog, where you can see this in use.