• Status Closed
  • Percent Complete
  • Task Type Patches
  • Category Manual
  • Assigned To No-one
  • Operating System All players
  • Severity Low
  • Priority Very Low
  • Reported Version
  • Due in Version Undecided
  • Due Date Undecided
  • Votes
  • Private
Attached to Project: Rockbox
Opened by bluebrother - 2006-03-29

FS#4944 - use tabularx for tables to eliminate overful boxes

The tables in the manual are using the standard “tabular” environment. This leads to a lot of overful boxes (at least in the current cvs version) and long lines need to be broken by hand.
Using the “tabularx” environment makes it possible to break lines within table columns automatically. It also has the advantage that you can specify the width of the table.

The attached patch changes the following for the wps section of the manual:
- use tabularx for tables
- make all tables as width as \\textwidth (which looks way better imo)
- remove some hand-splitted lines and let LaTeX break them automatically.

Please tell me your thoughts on this.

Closed by  tucoz
2006-03-29 18:40
Reason for closing:  Accepted
tucoz commented on 2006-03-29 16:22

I like it. I was actually looking for something like this, so nice catch :)
I will probably commit this later tonight.

If you're interested I'm willing to look over the manual replacing tabular on more sections the next time. Unfortunately I haven't done LaTeX for quite some time but this shouldn't be a big problem ;-)

Another note: I noticed the manual uses the standard LaTeX "report" style with a4paper. This produces pretty big margins (as the stlyes are designed to use letter formats). Maybe using KOMA-Script (which is designed to use the A4 format as default) makes this look more nice? For my documents I like KOMA-Script a lot better than the standard styles. Just tried it on the rockbox manual and also like it better.

I just noticed I missed a table in my last patch. Attached is an updated version
- add the missing table
- change some more hard-broken tables to be broken automatically

Change the appendix.tex file as well. This patch depends on the first one, completing the appendix/ folder. Btw, how can I open a related task?

tucoz commented on 2006-03-29 18:14

You are most welcome to help out with the manual in whatever way you find suitable. And fixing the tables and making the manual look better is definitely things that needs some attention. I don't know how you open a related task, but I can commit your current patches and close this task. Btw, do you know how we could use the KOMA-Script for the rockbox manual? That is, how do we install that package. Should we bundle the KOMA-Script in the manual folder?

KOMA-Script is part of most LaTeX installations (in my case tetex-latex package on Fedora Core), so no need to bundle it with the rbx-manual. MikTeX comes also with it (but not the minimal install). Are there other LaTeX distributions out there we need to check?

something went wrong when diffing man-tabularx-on-wps2.patch – this one should apply cleanly.


Available keyboard shortcuts


Task Details

Task Editing