Help:Wikilog settings

From EduTech Wiki
Jump to: navigation, search
Wikilog.pngWikilog user manualIntroductionWikilogsArticlesAdvanced
OverviewSettings

Each wikilog has a few settings that can be set by adding some special markup to the wikilog page. These settings are more relevant to the syndication feeds (Atom and RSS) that are automatically generated by Wikilog.

1 Icon, logo and subtitle

In order to adjust the icon, logo and subtitle of the wikilog, the {{wl-settings:...}} parser function should be added to the text of the wikilog page. This parser function has the following format (bolds are fixed text, italics are variable text):

{{wl-settings:
 | icon = icon file
 | logo = logo file
 | subtitle = subtitle message
}}

The three middle lines (icon, logo and subtitle) are all optional, and should only be provided if that information is to be set.

1.1 Icon

The icon parameter to the {{wl-settings:...}} parser function provides an iconic identification for the wikilog. The icon should be a small square image and has the same principle as website favicons. Icons are used only in Atom feeds [1].

The icon file argument should consist of a simple image wikilink to the file that contains the icon. The file must have been uploaded and be accessible from the wiki.

For example, the following block of text defines the icon of the wikilog to be ExampleIcon.png:

{{wl-settings:
 | icon = [[Image:ExampleIcon.png]]
}}

Many syndication feed readers don't support feed icons.

The logo parameter to the {{wl-settings:...}} parser function provides a visual identification for the wikilog. Logos are used in both Atom and RSS feeds, but has different restrictions. The Atom specification recommends that the image have a landscape orientation with 2 to 1 aspect ratio [2], while the RSS specification restricts the image size to 144×400 pixels maximum [3]. A good compromise between both specifications is a logo with dimensions of 144×72 pixels.

The logo file argument in the above example should consist of a simple image wikilink to the file that contains the logo. The file must have been uploaded and be accessible from the wiki. For example, the following block of text defines the logo of the wikilog to be ExampleLogo.png:

{{wl-settings:
 | logo = [[Image:ExampleLogo.png]]
}}

Many syndication feed readers don't support feed logos.

1.3 Subtitle

The subtitle parameter to the {{wl-settings:...}} parser function provides a short description about the wikilog. It is used in both Atom and RSS feeds. Wiki markup is allowed, but only possible in Atom feeds (RSS feeds will have only text).

For example, the following block of text defines the subtitle of the wikilog to be Random rants:

{{wl-settings:
 | subtitle = Random rants
}}

2 Authors

It is possible to globally define the authors of a wikilog through the {{wl-author:...}} parser function. Many authors can be provided, separated by pipe ("|") characters. The markup can also appear many times in the contents of wikilog page. In both cases, multiple authors are defined.

{{wl-author: author name }}
{{wl-author: first author | second author | ... }}

The author name should be the name of the user in the wiki. The wiki user page is linked back from the syndication feeds.

Note: This feature is provided only for completeness and its usage is not recommended. The expected usage is to provide authors individually for each wikilog article published in the wikilog, through the {{wl-publish:...}} parser function in the wikilog article page.

3 References

This page is part of the Wikilog extension user manual, which is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported License. The original text is available at the extension site.