| 1 |
neysx 08/02/22 17:10:07 |
| 2 |
|
| 3 |
Modified: announcement-guide.xml |
| 4 |
Log: |
| 5 |
Minor fixes. Free of charge. |
| 6 |
|
| 7 |
Revision Changes Path |
| 8 |
1.3 xml/htdocs/proj/en/pr/docs/announcement-guide.xml |
| 9 |
|
| 10 |
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/pr/docs/announcement-guide.xml?rev=1.3&view=markup |
| 11 |
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/pr/docs/announcement-guide.xml?rev=1.3&content-type=text/plain |
| 12 |
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/pr/docs/announcement-guide.xml?r1=1.2&r2=1.3 |
| 13 |
|
| 14 |
Index: announcement-guide.xml |
| 15 |
=================================================================== |
| 16 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/pr/docs/announcement-guide.xml,v |
| 17 |
retrieving revision 1.2 |
| 18 |
retrieving revision 1.3 |
| 19 |
diff -u -r1.2 -r1.3 |
| 20 |
--- announcement-guide.xml 20 Feb 2008 07:01:19 -0000 1.2 |
| 21 |
+++ announcement-guide.xml 22 Feb 2008 17:10:07 -0000 1.3 |
| 22 |
@@ -1,20 +1,20 @@ |
| 23 |
<?xml version="1.0" encoding="UTF-8"?> |
| 24 |
|
| 25 |
-<!-- $Header $ --> |
| 26 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/pr/docs/announcement-guide.xml,v 1.3 2008/02/22 17:10:07 neysx Exp $ --> |
| 27 |
|
| 28 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 29 |
|
| 30 |
<guide disclaimer="draft" link="announcement-guide.xml" lang="en"> |
| 31 |
- <title>Annonucement Guide</title> |
| 32 |
+ <title>Announcement Guide</title> |
| 33 |
<author title="Author"> |
| 34 |
- <mail link="nichoj@g.o">Josh Nichols</mail> |
| 35 |
+ <mail link="nichoj"/> |
| 36 |
</author> |
| 37 |
|
| 38 |
<abstract> |
| 39 |
This guide documents the proccess of posting announcements to the front page. It also provides guidelines, suggestions, tips, and references for writing effective announcements. |
| 40 |
</abstract> |
| 41 |
<version>0.1</version> |
| 42 |
- <date>2008-02-20</date> |
| 43 |
+ <date>2008-02-22</date> |
| 44 |
|
| 45 |
<chapter> |
| 46 |
<title>Creating announcements</title> |
| 47 |
@@ -25,13 +25,13 @@ |
| 48 |
To start, you'll need to go through all the setup you would need to do other documentation. This is already well documented <uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">here</uri>. |
| 49 |
</p> |
| 50 |
<p> |
| 51 |
- Announcements live in <path>xml/htdocs/proj/en/pr/docs</path>, relative to the root of the 'gentoo' CVS module. To create a new announcement, just create a new XML file in this directory. Typically, this is of the form <path>YYYYmmdd-some-title-here.xml</path>. |
| 52 |
+ Announcements live in <path>xml/htdocs/news/</path>, relative to the root of the 'gentoo' CVS module. To create a new announcement, just create a new XML file in this directory. Typically, this is of the form <path>YYYYmmdd-some-title-here.xml</path>. |
| 53 |
</p> |
| 54 |
<p> |
| 55 |
- The order of announcements is determined by the contents of <path>/dyn/news-index.xml</path>. This file gets generated by a cron job, which does something like <path>ls -r</path>. This means that you something like ZZ.xml would always show up first. |
| 56 |
+ The order of announcements is determined by the contents of <path>/dyn/news-index.xml</path>. This file gets generated by a cron job, which does something like <c>ls -r</c>. This means that something like ZZ.xml would always show up first. |
| 57 |
</p> |
| 58 |
<p> |
| 59 |
- If you want to public <b>several items on the same day</b> with a specific order, <b>add an extra letter</b> to the data, like <path>20080211a-foo.xml</path> and <path>20080211b-bar.xml</path>. |
| 60 |
+ If you want to publish <b>several items on the same day</b> with a specific order, <b>add an extra letter</b> to the data, like <path>20080211a-foo.xml</path> and <path>20080211b-bar.xml</path> (the latter will appear above the former). |
| 61 |
</p> |
| 62 |
</body> |
| 63 |
</section> |
| 64 |
@@ -39,7 +39,7 @@ |
| 65 |
<title>File format</title> |
| 66 |
<body> |
| 67 |
<p> |
| 68 |
- Announcements are of a variation of your typical <uri link="">GuideXML</uri>. |
| 69 |
+ Announcements are of a variation of your typical <uri link="/doc/en/xml-guide.xml">GuideXML</uri>. |
| 70 |
</p> |
| 71 |
<p> |
| 72 |
Best to teach by example, so here's a basic one: |
| 73 |
@@ -85,8 +85,8 @@ |
| 74 |
<p>You'd add a snippet like so:</p> |
| 75 |
<pre caption="Discussion link"><![CDATA[<p> |
| 76 |
<uri link="http://forums.gentoo.org/viewtopic-t-657125.html">Discuss this!</uri> |
| 77 |
-</p>]]> |
| 78 |
- </pre> |
| 79 |
+</p> |
| 80 |
+]]></pre> |
| 81 |
</body> |
| 82 |
</section> |
| 83 |
</chapter> |
| 84 |
@@ -124,7 +124,7 @@ |
| 85 |
Avoid overly long paragraphs. |
| 86 |
</li> |
| 87 |
<li> |
| 88 |
- Use bullet points and tables when appropriate. It is a lot easier to read a list of bullet point list, than an equivilant sentence. |
| 89 |
+ Use bullet points and tables when appropriate. It is a lot easier to read a list of bullet point list, than an equivalent sentence. |
| 90 |
</li> |
| 91 |
<li> |
| 92 |
Speak directly to the user. |
| 93 |
@@ -193,4 +193,4 @@ |
| 94 |
</body> |
| 95 |
</section> |
| 96 |
</chapter> |
| 97 |
-</guide> |
| 98 |
\ No newline at end of file |
| 99 |
+</guide> |
| 100 |
|
| 101 |
|
| 102 |
|
| 103 |
-- |
| 104 |
gentoo-commits@l.g.o mailing list |
Archives