fsfe-website/contribute/web/tagging.en.xhtml

143 lines
4.7 KiB
HTML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<html>
<version>1</version>
<head>
<title>Documentation - Tagged news and events, country pages</title>
</head>
<body class="article web" microformats="h-entry" id="documentation-tags">
<p id="category"><a href="/contribute/web/">Webmastering</a></p>
<h1 class="p-name">Documentation: Tagged news and events, country pages</h1>
<div class="e-content">
<p id="introduction" class="p-summary">
As you can see on <a href="/uk/uk.html">the UK page</a>,
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>
<h2>Basic instructions</h2>
<p>
A tag key should be in lowercase and not contain any spaces, colons, and slashes. So for instance, the key for the tag “very important subject” should be <code>very-important-subject</code>.
The content of the tag 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.
</p>
<pre class="file">
&lt;tag key="windows-tax"&gt;Windows Tax&lt;/tag&gt;
</pre>
<h2>Tag pages, news and events</h2>
<p>For most pages (when your file has the <var>xhtml</var>), the tags must be added within &lt;html&gt; &lt;/html&gt; usually at the end.</p>
<p>
A list of tags currently in use can be found <a href="/tags/tags.html">here</a>.
We also have a list of <a href="/tags/tagged.html">all tagged pages, events and news</a>. <strong>Please check these pages first</strong> to avoid making duplicated tags, use existing tags if possible to keep things consistent.
</p>
<ul>
<li>For certain news item the tags must be within &lt;news&gt; &lt;/news&gt; if your file has the <var>xml</var> extension:</li>
</ul>
<pre class="file">
&lt;news&gt;
[...]
&lt;tags&gt;
&lt;tag key="front-page"/&gt;
&lt;tag key="swpat"&gt;Software Patents&lt;/tag&gt;
&lt;tag key="novell"&gt;Novell&lt;/tag&gt;
&lt;/tags&gt;
&lt;/news&gt;
</pre>
<ul>
<li>For events, within &lt;event&gt; &lt;/event&gt;:</li>
</ul>
<pre class="file">
&lt;event&gt;
[...]
&lt;tags&gt;
&lt;tag key="front-page"/&gt;
&lt;tag key="it"&gt;Italy&lt;/tag&gt;
&lt;/tags&gt;
&lt;/event&gt;
</pre>
<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>
<p>
Tag keys should all be written in English; there is no need for translation
since they do not appear online, but are used internally for
filtering news items or events.
</p>
<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">
&#60;author&#62;
&#60;name&#62;John Doe&#60;/name&#62;
&#60;link&#62;http://johndoe.me&#60;/link&#62;
&#60;avatar&#62;http://johndoe.me/me.png&#60;/avatar&#62;
&#60;/author&#62;
&#60;!-- For FSFE team members, you can take the information directly
from /about/people/people.en.xml, for instance: --&#62;
&#60;author id="gerloff" /&#62;
&#60;date&#62;
&#60;revision content="2010-03-24" /&#62;
&#60;original content="2009-11-27" /&#62;
&#60;/date&#62;
&#60;!-- Feel free to add more than one revision tag if see fit --&#62;
&#60;download type="pdf" content="/link/to/download-file.pdf" /&#62;
</pre>
<p>
Bear in mind that these tags should be included like any other tags, that means they should be at the end, before &#60;/html&#62;
</p>
</div>
<!--/e-content-->
</body>
<sidebar promo="about-fsfe">
<div id="related-content">
<h3>Other howtos:</h3>
<ul>
<li>
<a href="/contribute/web/css.html">Edit the CSS with LESS</a>
</li>
<li>
<a href="/contribute/template.html">A template article, to use the new webdesign</a>
</li>
<li>
<a href="/contribute/campaigns-frontpage.html">Add and select campaign banners for the frontpage</a>
</li>
</ul>
</div>
</sidebar>
<timestamp>$Date: 2010-07-07 05:16:55 +0200 (Wed, 07 Jul 2010) $ $Author: hugo $</timestamp>
</html>
<!--
Local Variables: ***
mode: xml ***
End: ***
-->