From: Ciaran Gultnieks <ciaran@ciarang.com>
Date: Mon, 17 Sep 2012 21:28:08 +0000 (+0100)
Subject: Basic docs for description formatting
X-Git-Tag: 0.1~747^2~1
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=commitdiff_plain;h=a11d55620b513bab5e354a54c55ec7c34e92a634;p=fdroidserver.git

Basic docs for description formatting
---

diff --git a/docs/fdroid.texi b/docs/fdroid.texi
index 52f9a39c..3c866862 100644
--- a/docs/fdroid.texi
+++ b/docs/fdroid.texi
@@ -583,8 +583,22 @@ A brief summary of what the application is.
 
 @cindex Description
 
-A full description of the application. This can span multiple lines, and is
-terminated by a line containing a single '.'.
+A full description of the application. This can span multiple lines (which
+should be kept to a maximum of 80 characters), and is terminated by a line
+containing a single '.'.
+
+Basic MediaWiki-style formatting can be used. Leaving a blank line starts a
+new paragraph. Surrounding text with @code{''} make it italic, and with
+@code{'''} makes it bold.
+
+You can link to another app in the repo by using @code{[[app.id]]}. The link
+will be made appropriately whether in the Android client, the web repo
+browser or the wiki. The link text will be the apps name.
+
+Links to web addresses can be done using @code{[http://example.com Text]}.
+
+Bulletted lists are done by simply starting each item with a @code{*} on
+a new line, and numbered lists are the same but using @code{#}.
 
 @node Repo Type
 @section Repo Type