1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

The Manual Reader with c:geo manual opened. The Manual Reader icon

The Manual Reader for …

Symbol for role "reader". From: http://wiki.ubuntuusers.de/Wiki/Icons/Oxygen

End Users

  • This is an easy to use and install app for Android™, so you can read application manuals directly on your mobile device without the need for an online Internet connection.
  • Learn more about The Manual Reader.
  • If you want to see a live manual, we also have the «c:geo ~ manual» online. We have even the German «c:geo ~ manual» onlineWarning: does not work on IE; use a real browser instead, not this broken-beyond-repair piece of crap. Install Firefox, Chrome, whatever else, but not this IE trash.

Symbol for role "author". From: http://wiki.ubuntuusers.de/Wiki/Icons/Oxygen

Authors

  • We make it easy for you to author new manuals using your ordinary web browser. Thus, there is no need for a special, locked authoring tool. Albeit you are free to write one for yourself.
  • Learn more about authoring manuals for The Manual Reader. This should give you a fair impression on how the whole process works.

Symbol for role "packager". From: http://wiki.ubuntuusers.de/Wiki/Icons/Oxygen

Distributors

  • Easy to use from your existing Apps and easy to distribute. Disseminate your manuals through the same channel as your apps: the Android Market.
  • And if you invest a small integration effort, you can even score with your users by offering context-sensitive manual help.
  • It is even possible to integrate the Manual Reader directly into your app without the need for a separate software package. While we don't see this is a good idea, there may be legitimate reasons we don't want to block. This is free software, after all! But read the license conditions below. Don't be afraid.
  • Learn more about packaging and distributing The Manual Reader.

Symbol for role "developer". From: http://wiki.ubuntuusers.de/Wiki/Icons/Oxygen

Developers

Licensing

  • The Manual Reader Client for integration is licensed under the LGPLv3 to allow hassle-free integration even into proprietary apps. The simple rule of thumb here is: put this package into your app and if you modify anything in this package, you need to make this changes available in case you distribute your app. Please note that The Manual Reader itself is separate and cannot be directly included with your package unless you license your app under a GPLv3-compatible license.
  • The Manual Reader itself is licensed under the GPLv3. Whatever you hack here you have to give back to everyone if you distribute your modified manual reader app.
  • The c:geo Manual is licensed under the CC-BY-NC-SA. Please see the manual itself for more details.
  • The Manual Mechanics – the technology underlying manuals – is licensed under a modified BSD license (without the advertising clause). These mechanics consist of the TiddlyWiki base with !iTW and The Manual Reader adaptions on top.

Software

  • Android App apk – it is now also available through the Android Market, so please head over there: c:geo ~ manual (en).
  • Source code and manual repository
    • appmanualreader – git repository containing the source code (Android/Eclipse library project) for The Manual Reader. This is just the basic part, not to be compiled into a stand-alone application.
    • cgeomanual-en – git repository containing the manual TiddlyWiki and image/icon sources for the «c:geo manual» in English. This also contains the Android/Eclipse project setup and thus can be used to compile the final manual app containing the c:geo manual.
    • cgeomanual-de – git repository containing the manual TiddlyWiki and image/icon sources for the «c:geo Anleitung» in German. This also contains the Android/Eclipse project setup and thus can be used to compile the final manual app containing the c:geo manual.
    • emptymanual – git repository for the empty skeleton manual. Pending as SourceForge has temporarily disabled some services following a security breach and we cannot upload a new repository.

Help Us

Helping hands are always welcome, be it help improving manual content, or be it help improving The Manual Reader code base. Please contact the project owner. You are welcome!

Further Starting Points

For a complete list of local wiki pages, see TitleIndex.

Attachments