Documentation: Tagged news and events, country pages

As you can see on the UK page, it is possible to display news or events that have a special tag, e.g. a country code. This helps setting up pages easily with specific news items or events. The list of people displayed on this same page has also been automated, so it makes it easy to implement your own country page.

The first system we have used, an attribute consisting of comma-separated values, was not very adapted to the way we generate dynamic information. Therefore, we have opted for the hereunder defined system, a more xml-style one.

Basic instructions

A tag should be in CamelCase except for special tags like front-page, newsletter. So for instance, the tag “very important subject” should be VeryImportantSubject. A tag should contain a content attribute except for special tags. This attribute should be translated and human readable, because it will be shown on certain pages. For instance, if you tag a page about the Windows Tax:

      <tag content="Windows Tax">WindowsTax</tag>

Tagged news and events

In order to retrieve news items or events with a given tag, these have of course to be tagged accordingly. To do that, add as many <tag content="">...</tag> as necessary in the tags section.

A list of tags currently in use can be found here. We also have a list of all tagged pages, events and news. Please check these pages first to avoid making duplicated tags, use existing tags if possible to keep things consistent.

      <tag content="Software Patents">Swpats</tag>
      <tag content="Novell">Novell</tag>
      <tag content="Software Patents">Swpats</tag>
      <tag content="Novell">Novell</tag>
      <tag content="Italy">it</tag>

Please note that only events and news items being tagged as front-page will appear on the front page of fsfe.org!

Tags should all be written in English; there is no need for translation since the tags do not appear online, but are used internally for filtering news items or events.

Using the fetch-news template

<xsl:with-param name="tag" select="'your tag'"/>
<xsl:with-param name="nb-items" select="'x'" />

Using the fetch-newsletter template

Works exactly as the fetch-news template, but does not propose tagging yet.

Using the fetch-events template

fetch-events works in a very similar manner to fetch-news, tag and nb-items work the same way. Here are some addings:

<xsl:with-param name="wanted-time" select="'future|present|past'" />
<xsl:with-param name="header" select="'future|current|past'" />
<xsl:with-param name="display-details" select="'yes|no'" />

Implementing a country page

Implementing a country page won't take you long. United Kingdom and Germany country pages are a good example of what you can achieve easily and how.

1. The very first thing to do is to create a folder with your country code, e.g. "/de", "/uk" or "/it" in the root folder of the fsfe-web svn (you will see other country folders there).
You may want to copy the three common files you'll find in already existing country folders, e.g uk.en.xhtml, uk.xsl and uk.sources, and of course rename them accordingly.

2. You should not have to modify **.sources. You want to change the countrycode variable in the **.xsl file to your country code, modifying the following line.

<xsl:variable name="country-code">xx</xsl:variable>
In the **.**.xhtml page, you should only change the identi.ca account, or deactivate it if your country team does not have one yet.
Play further with this file if you want to change the display of your country page.

Using the country-people-list template

<person id="mueller" member="yes" teams="main, de">

People tagged with your country code will appear in your country page's people list. (If you want to add a person that is not there yet, be careful not to add him/her to the "main" team if he/she is not a member of it).

For people's pictures, you should put a 48*48 pixels picture in the /about/id folder named id-avatar.jpg. Then edit /about/people/people.en.xml and add a line for avatar to the picture URL.

Tagging author, date and download files

In order to give proper credits to the authors of articles you can add tags like these:

          <name>John Doe</name>

        <!-- For FSFE team members, you can take the information directly
        from /about/people/people.en.xml, for instance: -->
        <author id="gerloff" />
          <revision content="2010-03-24" />
          <original content="2009-11-27" />
        <!-- Feel free to add more than one revision tag if see fit -->
        <download type="pdf" content="/link/to/download-file.pdf" />

Bear in mind that these tags should be included like any other tags, that means they should be at the end, before </html>

webmaster $Date: 2010-07-07 05:16:55 +0200 (Wed, 07 Jul 2010) $ $Author: hugo $