From 5d76ba0214bb77a1818f2541744d6c2650760614 2012-09-11 14:10:08 From: HanzZ Date: 2012-09-11 14:10:08 Subject: [PATCH] Docs update --- diff --git a/docs/guide/backends.textile b/docs/guide/backends.textile index a59a5762112df2bf674473bf567961784ddd89da..9af52ecd8986e8d9ac993a81ecbbf1b712714b70 100644 --- a/docs/guide/backends.textile +++ b/docs/guide/backends.textile @@ -1,5 +1,4 @@ -Spectrum 2 introduces backends. Backends are external application which provides a way how to connect to legacy networks, so it's possible to use -even different libraries than Libpurple to connect the legacy network. However, Libpurple is still the best library to use so far. +Spectrum 2 introduces backends. Backends are external application which provides a way how to connect to legacy networks, so it's possible to use even different libraries than Libpurple to connect the legacy network. However, Libpurple is still the best library to use so far. This page contains the list of currently supported backends with the basic information about them. @@ -13,10 +12,10 @@ Backends are switched in Spectrum 2 config file using the following option: h2. List of backends |_. Name|_. Supported networks|_. Default path to backend| -|Libpurple backend|AIM, Jabber, Facebook, GTalk, ICQ, MSN, Yahoo|/usr/bin/spectrum2_libpurple_backend| -|Swiften backend|Jabber, Facebook, GTalk|/usr/bin/spectrum2_swiften_backend| -|SLibCommuni backend|IRC|/usr/bin/spectrum2_libcommuni_backend| -|Frotz backend|Allows playing interactive-fiction games|/usr/bin/spectrum2_frotz_backend| -|Skype backend|Skype using the official client|/usr/bin/spectrum2_skype_backend| -|SMSTools3 backend|SMS using connected mobile phone|/usr/bin/spectrum2_smstools3_backend| -|Twitter backend|Twitter|/usr/bin/spectrum2_twitter_backend| +|Libpurple backend|AIM, Jabber, Facebook, GTalk, ICQ, MSN, Yahoo|@/usr/bin/spectrum2_libpurple_backend@| +|Swiften backend|Jabber, Facebook, GTalk|@/usr/bin/spectrum2_swiften_backend@| +|SLibCommuni backend|IRC|@/usr/bin/spectrum2_libcommuni_backend@| +|Frotz backend|Allows playing interactive-fiction games|@/usr/bin/spectrum2_frotz_backend@| +|Skype backend|Skype using the official client|@/usr/bin/spectrum2_skype_backend@| +|SMSTools3 backend|SMS using connected mobile phone|@/usr/bin/spectrum2_smstools3_backend@| +|Twitter backend|Twitter|@/usr/bin/spectrum2_twitter_backend@| diff --git a/docs/guide/index.textile b/docs/guide/index.textile index 3abb5bcdfb171eb9900e77856d41fc1933902bee..f358f7c8813ad0c48c0a3cd588eba690da1c4306 100644 --- a/docs/guide/index.textile +++ b/docs/guide/index.textile @@ -23,7 +23,7 @@ h2. Backends * "Backends overview":backends.html * "Libpurple backend":libpurple.html * "Swiften backend":swiften.html -* "Libcommuni backend":swiften.html +* "Libcommuni backend":libcommuni.html * "Skype backend":skype.html * "Twitter backend":twitter.html diff --git a/docs/guide/libpurple.textile b/docs/guide/libpurple.textile index e874b6bb238ca3af466ce48eec1e518ca59ccc9f..35ac1e4ffc9ad13631afea2b1684cd4f933fe953 100644 --- a/docs/guide/libpurple.textile +++ b/docs/guide/libpurple.textile @@ -7,8 +7,8 @@ h2. Configuration You have to choose this backend in Spectrum 2 configuration file to use it:
-[service]
-backend=/usr/bin/spectrum2_libpurple_backend
+	[service]
+	backend=/usr/bin/spectrum2_libpurple_backend
 
There is also special configuration variable in "service" called @protocol@ which decides which Libpurple's protocol will be used: diff --git a/docs/guide/template.html b/docs/guide/template.html index 99967f0164ac4482f1dd96b609ecec8e8015a040..d8515aa5637127552179368f07a9b1a2f19fcdeb 100644 --- a/docs/guide/template.html +++ b/docs/guide/template.html @@ -103,7 +103,7 @@ a img{ img{ display: block; max-width: 100%; } -code { +body.code { border: 1px solid #FB7A31; background: #FFC; } diff --git a/docs/guide/tutorial_gateway_mode.textile b/docs/guide/tutorial_gateway_mode.textile index be33e5d08b1adaa65226869abbf04d6c6dae6173..ddea00f2f4b241cd162e4797477e886c5ac48dc6 100644 --- a/docs/guide/tutorial_gateway_mode.textile +++ b/docs/guide/tutorial_gateway_mode.textile @@ -1,6 +1,6 @@ h2. Before you start -* Check that you really want to run Spectrum 2 in gateway mode and not in server mode. The difference is documentation on "What is Spectrum 2?":about.html page. +* Check that you really want to run Spectrum 2 in gateway mode and not in server mode. The difference is documentation on "What is Spectrum 2":about.html page. * Install Spectrum 2. Installation is covered in "Installation section on the main page":index.html. h2. Configure your XMPP server diff --git a/docs/guide/twitter.textile b/docs/guide/twitter.textile index e874b6bb238ca3af466ce48eec1e518ca59ccc9f..c1081767e651f1ad9646547a31a9a334dd9246a3 100644 --- a/docs/guide/twitter.textile +++ b/docs/guide/twitter.textile @@ -1,6 +1,6 @@ h2. Description -Libpurple backend is backend based on Librpurple library supporting all the networks supported by libpurple +Twitter backend is backend created during Summer of Code. It allows users to connect Twitter network. h2. Configuration @@ -8,17 +8,5 @@ You have to choose this backend in Spectrum 2 configuration file to use it:
 [service]
-backend=/usr/bin/spectrum2_libpurple_backend
+backend=/usr/bin/spectrum2_twitter_backend
 
- -There is also special configuration variable in "service" called @protocol@ which decides which Libpurple's protocol will be used: - -|_. Protocol variable|_. Description| -|prpl-jabber| Jabber/Facebook/GTalk| -|prpl-aim|AIM| -|prpl-icq|ICQ| -|prpl-msn|MSN| -|prpl-yahoo|Yahoo| -|prpl-gg|Gadu Gadu| -|prpl-novell|Groupwise| -