Editing Module:Current events calendar/doc

{{module rating|protected}}
{{Uses TemplateStyles|Module:Current events calendar/styles.css}}
{{high-use|543}}
This module generates calendars for [[Portal:Current events]] and [[:Category:Current events archives]]. The current day and the previous six days are linked to the corresponding section of the page. The module also supports archival calendars when month and year parameters are passed. Note that the Current Month version will only link the previous six days and will include a link of form: [[Portal:Current events/{{CURRENTMONTHNAME}} {{CURRENTYEAR}}|More {{CURRENTMONTHNAME}} {{CURRENTYEAR}} events...]].

== Usage on [[Portal:Current events]] ==

 &#123;{#invoke:current events calendar|main}}

== Usage on [[:Category:Current events archives]] pages ==

 &#123;{#invoke:current events calendar|main|year='''[four digit numerical year]'''|month='''[One or two digit number from 1 to 12]'''}}

== Example: Current Events front page version ==

This version assumes that it is displayed in a page that will set padding/margins/gutters in parent containing elements. It will expand to a maximum of 350px wide and remain centered in the column. It includes a link to the full month's page in the footer. Only the six most recent days of the month will have hyperlinks, reflecting the 6 most recent days of content on the [[Portal:Current events]] page.

{{#invoke:current events calendar|main}}

{{clear}}

== Example: Current Events archive version ==

This version assumes that it is displayed in a page that uses a table-based layout and expect individual children to set their margins and padding. It will expand to a maximum of 350px wide and puts an 8px margin on the top and left side of the calendar. It has no footer. All days will have links to the appropriate section of the page it is displayed in.

{{#invoke:current events calendar|main|year=1997|month=1}}

{{clear}}

== Sandbox version ==
{{#invoke:current events calendar/sandbox|main}}


<includeonly>{{Sandbox other||
[[Category:Time, date and calendar modules]]
}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>