Rockbox.org home
Downloads
Release release
Dev builds dev builds
Extras extras
themes themes
Documentation
Manual manual
Wiki wiki
Device Status device status
Support
Forums forums
Mailing lists mailing lists
IRC IRC
Development
Bugs bugs
Patches patches
Dev Guide dev guide
Search



Donate

Rockbox Technical Forums


Login with username, password and session length
Home Help Search Staff List Login Register
News:

Rockbox Ports are now being developed for various digital audio players!

+  Rockbox Technical Forums
|-+  Rockbox General
| |-+  Rockbox General Discussion
| | |-+  How to contribute to the manual?
« previous next »
  • Print
Pages: [1]

Author Topic: How to contribute to the manual?  (Read 1254 times)

Offline LucaLeonardo.Scorcia

  • Member
  • *
  • Posts: 4
How to contribute to the manual?
« on: September 16, 2007, 05:21:05 PM »
Today I found a missing info in the manual for my Sansa e200.
In the FM Radio (http://download.rockbox.org/manual/rockbox-sansae200/rockbox-buildch5.html#x8-900005.9) section, it is not specified that the Rec button is used to toggle between Preset mode and Scan mode.

When I discovered the right key, I tried to find the right way to contribute to the manual, but on the page http://www.rockbox.org/twiki/bin/view/Main/ManualHowto#How_may_I_help I got lost at the Patch creation. Patch for what?!? Where should I send it?

Since it's a small change, maybe some of the experts here will do this change for me, or teach me how to add things to the manual :)

So far, my first day with rockbox has been exciting. I have even created a new WPS and sent it on rockbox-themes.org! :D

To everyone that has contributed rockbox: GREAT JOB!
Logged
But the best thing God has created is a New Day.
(Sigur Ròs - Viðrar vel til loftárása)

Offline bluebrother

  • Developer
  • Member
  • *
  • Posts: 3421
  • creature
Re: How to contribute to the manual?
« Reply #1 on: September 16, 2007, 05:42:10 PM »
Quote from: LucaLeonardo.Scorcia on September 16, 2007, 05:21:05 PM
When I discovered the right key, I tried to find the right way to contribute to the manual, but on the page http://www.rockbox.org/twiki/bin/view/Main/ManualHowto#How_may_I_help I got lost at the Patch creation. Patch for what?!? Where should I send it?
The manual is written using LaTeX, a typsetting program. It uses plain text files as input that are formatted using a special markup. You can retrieve the source files from svn, and if you're capable of making changes to that sources this is where you should create a patch out of.

If you can't do that directly you can also submit a plain text file (no word processors please) including the new wording (and a notice where it should be located). In both cases the submission goes to our tracker (linked on the left-sided menu) and put in the "manual" category.

Quote
Since it's a small change, maybe some of the experts here will do this change for me, or teach me how to add things to the manual :)
If you want to contribute to the manual you should get yourself some basic knowledge about Latex (in case you don't know it). Then it shouldn't be too hard to make changes to the manual directly. Feel free to look around on IRC -- usually there are a few people around who can help you in starting to work at the manual and answering questions.
Logged
Rockbox Utility development binaries (updated infrequently) · How to ask questions the smart way · We do not estimate timeframes.

  • Print
Pages: [1]
« previous next »
+  Rockbox Technical Forums
|-+  Rockbox General
| |-+  Rockbox General Discussion
| | |-+  How to contribute to the manual?
 

  • SMF 2.0.17 | SMF © 2019, Simple Machines
  • Rockbox Privacy Policy
  • XHTML
  • RSS
  • WAP2

Page created in 0.063 seconds with 15 queries.