Difference between revisions of "Template:LogList"
From Masq
m |
m |
||
| Line 34: | 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 41: | 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 === | ||
| Line 59: | Line 60: | ||
|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 | + | |
| + | 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'. | ||
<pre> | <pre> | ||
| Line 65: | Line 67: | ||
|date_style=RL | |date_style=RL | ||
|explain_date=yes | |explain_date=yes | ||
| + | |reverse=yes | ||
|------------------- | |------------------- | ||
|the_log~[[Jai - Sugar Lumps]] | |the_log~[[Jai - Sugar Lumps]] | ||
| Line 78: | Line 81: | ||
|date_style=RL | |date_style=RL | ||
|explain_date=yes | |explain_date=yes | ||
| + | |reverse=yes | ||
|------------------- | |------------------- | ||
|the_log~[[Jai - Sugar Lumps]] | |the_log~[[Jai - Sugar Lumps]] | ||
| Line 92: | Line 96: | ||
** Using a ~ or an = 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 | + | ** 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, or whatever combination you like. | + | ** 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> | ||
Revision as of 09:00, 13 February 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.
Examples
{{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.
}}
The basic use, giving you:
| 01/23/2008: Sugar Lumps When you party with the party prince, you get two complimentary after-dinner mints. |
| 09/12/2009: Fork In The Road 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'.
{{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.
}}
| 10/21/2010: Sugar Lumps When you party with the party prince, you get two complimentary after-dinner mints. |
| 11/23/2011: This Is The Title I Prefer In which Petra presents Jai with a decent proposal, for a change. |
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.