2011-01-13 11:18:51 +00:00
|
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
|
|
|
|
|
<html>
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<title>Documentation - Tagged news and events, country pages</title>
|
|
|
|
|
|
</head>
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
|
|
<p id="category"><a href="/contribute/">Contribute</a></p>
|
|
|
|
|
|
<h1>Documentation - Tagged news and events, country pages</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<p id="introduction">
|
2011-05-31 08:57:16 +00:00
|
|
|
|
As you can see on <a href="/uk/uk.html">the UK page</a>,
|
2011-01-13 11:18:51 +00:00
|
|
|
|
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.
|
|
|
|
|
|
</p>
|
2011-01-21 12:39:52 +00:00
|
|
|
|
|
|
|
|
|
|
<p>
|
2011-01-21 13:03:09 +00:00
|
|
|
|
<img src="/graphics/icons/warning.png" />
|
2011-01-21 12:39:52 +00:00
|
|
|
|
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.
|
|
|
|
|
|
</p>
|
2011-01-13 11:18:51 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Tagged news and events</h2>
|
|
|
|
|
|
|
2011-01-13 15:38:59 +00:00
|
|
|
|
<p>In order to retrieve news items or events with a given tag, these
|
2011-01-21 12:57:32 +00:00
|
|
|
|
have of course to be tagged accordingly. To do that, add as many
|
2011-01-21 13:03:45 +00:00
|
|
|
|
<tag>...</tag> as necessary in the tags section.</p>
|
2011-01-13 15:38:59 +00:00
|
|
|
|
|
2011-01-21 13:14:45 +00:00
|
|
|
|
<p>
|
|
|
|
|
|
A list of tags currently in use can be found <a href="/tags/tags.html">here</a>.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
2011-01-13 15:38:59 +00:00
|
|
|
|
<ul>
|
2011-01-21 12:50:00 +00:00
|
|
|
|
<li>For news items and newsletters, within <html> </html> if your file has the <var>xhtml</var> extension:</li>
|
2011-01-13 15:38:59 +00:00
|
|
|
|
</ul>
|
|
|
|
|
|
|
2011-01-21 12:50:00 +00:00
|
|
|
|
<p class="terminal">
|
|
|
|
|
|
<html><br/>
|
|
|
|
|
|
[...]<br/>
|
|
|
|
|
|
<tags><br/>
|
|
|
|
|
|
<tag>front-page</tag><br/>
|
|
|
|
|
|
<tag>swpats</tag><br/>
|
|
|
|
|
|
<tag>novell</tag><br/>
|
|
|
|
|
|
</tags><br/>
|
|
|
|
|
|
</html>
|
|
|
|
|
|
</p>
|
2011-01-13 15:38:59 +00:00
|
|
|
|
|
|
|
|
|
|
<ul>
|
2011-01-21 12:50:00 +00:00
|
|
|
|
<li>And, within <news> </news> if your file has the <var>xml</var> extension:</li>
|
2011-01-13 15:38:59 +00:00
|
|
|
|
</ul>
|
|
|
|
|
|
|
2011-01-21 12:50:00 +00:00
|
|
|
|
<p class="terminal">
|
|
|
|
|
|
<news><br/>
|
|
|
|
|
|
[...]<br/>
|
|
|
|
|
|
<tags><br/>
|
|
|
|
|
|
<tag>front-page</tag><br/>
|
|
|
|
|
|
<tag>swpats</tag><br/>
|
|
|
|
|
|
<tag>novell</tag><br/>
|
|
|
|
|
|
</tags><br/>
|
|
|
|
|
|
</news>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>For events, within <event> </event>:</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="terminal">
|
|
|
|
|
|
<event><br/>
|
|
|
|
|
|
[...]<br/>
|
|
|
|
|
|
<tags><br/>
|
|
|
|
|
|
<tag>front-page</tag><br/>
|
|
|
|
|
|
<tag>it</tag><br/>
|
|
|
|
|
|
</tags><br/>
|
|
|
|
|
|
</event>
|
|
|
|
|
|
</p>
|
2011-01-13 15:38:59 +00:00
|
|
|
|
|
|
|
|
|
|
<p>Please note that only events and news items being tagged as <var>front-page</var>
|
|
|
|
|
|
will appear on the front page of fsfe.org!</p>
|
|
|
|
|
|
|
2011-01-17 15:19:19 +00:00
|
|
|
|
<p>
|
|
|
|
|
|
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.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
2011-01-13 15:38:59 +00:00
|
|
|
|
|
2011-01-13 11:18:51 +00:00
|
|
|
|
<h3>Using the fetch-news template</h3>
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
2011-01-13 11:35:49 +00:00
|
|
|
|
the <var>tag</var> parameter defines what news will be displayed. If you are
|
2011-01-13 11:18:51 +00:00
|
|
|
|
building up a country page, this is your country code. Leave blank
|
|
|
|
|
|
if you wish to receive news items with any tags.
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
2011-01-13 11:35:49 +00:00
|
|
|
|
<p class="terminal"><xsl:with-param name="tag" select="'<var>your tag</var>'"/></p>
|
2011-01-13 11:18:51 +00:00
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
2011-01-13 11:35:49 +00:00
|
|
|
|
the <var>nb-items</var> parameter determines how many news items will be displayed
|
2011-01-13 11:18:51 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
2011-01-13 11:35:49 +00:00
|
|
|
|
<p class="terminal"><xsl:with-param name="nb-items" select="'<var>x</var>'" /></p>
|
2011-01-13 11:18:51 +00:00
|
|
|
|
|
|
|
|
|
|
|
2011-01-13 12:37:14 +00:00
|
|
|
|
<h3>Using the fetch-newsletter template</h3>
|
|
|
|
|
|
|
|
|
|
|
|
<p>Works exactly as the fetch-news template, but does not propose tagging yet.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
2011-01-13 11:18:51 +00:00
|
|
|
|
<h3>Using the fetch-events template</h3>
|
|
|
|
|
|
|
|
|
|
|
|
<p>
|
2011-01-13 12:37:14 +00:00
|
|
|
|
fetch-events works in a very similar manner to fetch-news, <var>tag</var> and <var>nb-items</var>
|
2011-01-13 11:18:51 +00:00
|
|
|
|
work the same way. Here are some addings:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
2011-01-13 12:37:14 +00:00
|
|
|
|
the <var>wanted-time</var> parameter defines what events you want
|
|
|
|
|
|
to display, "past", "present" or "future"
|
2011-01-13 11:18:51 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
2011-01-13 11:35:49 +00:00
|
|
|
|
<p class="terminal"><xsl:with-param name="wanted-time" select="'<var>future|present|past</var>'" /></p>
|
2011-01-13 11:18:51 +00:00
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
2011-01-13 11:35:49 +00:00
|
|
|
|
the <var>header</var> parameter determines the text that will be displayed on top
|
|
|
|
|
|
of your block of events (used e.g. on events/events.xsl).
|
2011-01-13 12:37:14 +00:00
|
|
|
|
Possible values are 'future', 'current' or 'past'. Leave blank if you
|
|
|
|
|
|
don't want any header.
|
2011-01-13 11:18:51 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
2011-01-13 11:35:49 +00:00
|
|
|
|
<p class="terminal"><xsl:with-param name="header" select="'<var>future|current|past</var>'" /></p>
|
2011-01-13 11:18:51 +00:00
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li>
|
2011-01-13 11:35:49 +00:00
|
|
|
|
the <var>display-details</var> parameter says if 'yes' or 'no' you will have
|
2011-01-13 12:37:14 +00:00
|
|
|
|
the text of each event displayed along with its date and title.
|
2011-01-13 11:18:51 +00:00
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
2011-01-13 11:35:49 +00:00
|
|
|
|
<p class="terminal"><xsl:with-param name="display-details" select="'<var>yes|no</var>'" /></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Implementing a country page</h2>
|
|
|
|
|
|
|
|
|
|
|
|
<p>
|
2011-04-01 15:19:13 +00:00
|
|
|
|
Implementing a country page won't take you long.
|
|
|
|
|
|
<a href="/uk/uk.html">United Kingdom</a> and
|
|
|
|
|
|
<a href="/de/de.html">Germany</a> country pages are a good example
|
|
|
|
|
|
of what you can achieve easily and how.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
<strong>1. </strong>
|
|
|
|
|
|
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).<br/>
|
|
|
|
|
|
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.
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
<strong>2. </strong>
|
|
|
|
|
|
You should not have to modify **.sources.
|
|
|
|
|
|
You want to change the <var>countrycode</var>
|
|
|
|
|
|
variable in the **.xsl file to your country code, modifying the
|
|
|
|
|
|
following line.
|
2011-01-13 11:35:49 +00:00
|
|
|
|
|
2011-04-01 15:19:13 +00:00
|
|
|
|
<p class="terminal"><xsl:variable name="country-code"><var>xx</var></xsl:variable></p>
|
|
|
|
|
|
|
|
|
|
|
|
In the **.**.xhtml page, you should only change the identi.ca
|
|
|
|
|
|
account, or deactivate it if your country team does not have one yet.
|
|
|
|
|
|
|
|
|
|
|
|
<p class="terminal">"user":"fsfeuk",</p>
|
|
|
|
|
|
|
|
|
|
|
|
Play further with this file if you want to change the display of
|
|
|
|
|
|
your country page.
|
|
|
|
|
|
|
2011-01-13 11:35:49 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Using the country-people-list template</h3>
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
2011-04-01 15:25:52 +00:00
|
|
|
|
<li>(the call to country-people-list in **.xsl is responsible for the displayed people list)</li>
|
2011-01-13 11:35:49 +00:00
|
|
|
|
<li>add the <var>xx</var> tag to corresponding people in /about/people/people.en.xml, e.g.</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="terminal"><person id="mueller" member="yes" teams="main, de"></p>
|
2011-04-01 15:19:13 +00:00
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
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).
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<p>
|
2012-04-22 15:03:51 +00:00
|
|
|
|
For people's pictures, you should put a 48*48 pixels picture in the
|
2012-04-23 14:44:58 +00:00
|
|
|
|
/about/<var>id</var> folder named <var>id</var>-avatar.jpg. Then edit
|
|
|
|
|
|
<var>/about/people/people.en.xml</var> and add a line for
|
|
|
|
|
|
<var>avatar</var> to the picture URL.
|
2011-04-01 15:19:13 +00:00
|
|
|
|
</p>
|
2011-04-01 15:25:52 +00:00
|
|
|
|
|
2012-04-22 15:03:51 +00:00
|
|
|
|
<h3>Tagging author, date and download files</h3>
|
|
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
In order to give proper credits to the authors of articles you can add
|
|
|
|
|
|
tags like these:
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
<pre class="file">
|
|
|
|
|
|
<author>
|
|
|
|
|
|
<name>John Doe</name>
|
|
|
|
|
|
<link>http://johndoe.me</link>
|
|
|
|
|
|
<avatar>http://johndoe.me/me.png</avatar>
|
|
|
|
|
|
</author>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- For FSFE team members, you can take the information directly
|
|
|
|
|
|
from /about/people/people.en.xml, for instance: -->
|
|
|
|
|
|
<author id="gerloff" />
|
|
|
|
|
|
|
|
|
|
|
|
<date>
|
|
|
|
|
|
<revision content="2010-03-24" />
|
|
|
|
|
|
<original content="2009-11-27" />
|
|
|
|
|
|
</date>
|
|
|
|
|
|
|
2012-04-23 14:44:58 +00:00
|
|
|
|
<!-- Feel free to add more than one revision tag if see fit -->
|
|
|
|
|
|
|
2012-04-22 15:03:51 +00:00
|
|
|
|
<download type="pdf" content="/link/to/download-file.pdf" />
|
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
2011-01-13 11:18:51 +00:00
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
|
|
<timestamp>$Date: 2010-07-07 05:16:55 +0200 (Wed, 07 Jul 2010) $ $Author: hugo $</timestamp>
|
|
|
|
|
|
</html>
|
|
|
|
|
|
<!--
|
|
|
|
|
|
Local Variables: ***
|
|
|
|
|
|
mode: xml ***
|
|
|
|
|
|
End: ***
|
|
|
|
|
|
-->
|
