chiark / gitweb /
Basic docs for description formatting
authorCiaran Gultnieks <ciaran@ciarang.com>
Mon, 17 Sep 2012 21:28:08 +0000 (22:28 +0100)
committerCiaran Gultnieks <ciaran@ciarang.com>
Mon, 17 Sep 2012 21:28:08 +0000 (22:28 +0100)
docs/fdroid.texi

index 52f9a39ccece8727541ef3bbdacd811ff570802a..3c866862b5e18ff741b7faff5905c76764a3973d 100644 (file)
@@ -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