After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 330812 - convert tables to variablelists
convert tables to variablelists
Status: RESOLVED OBSOLETE
Product: gnome-user-docs
Classification: Core
Component: user-guide
2.4
Other Linux
: Normal enhancement
: ---
Assigned To: Thijs Thiessens
Thijs Thiessens
Depends on:
Blocks:
 
 
Reported: 2006-02-11 17:46 UTC by Joachim Noreiko
Modified: 2011-04-24 15:53 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
changes table to variablelist for gconf command options (23.20 KB, patch)
2006-02-16 04:39 UTC, Brent Smith (smitten)
none Details | Review
another patch - same as last, except change <para> to <literallayout> to remove justification (40.13 KB, patch)
2006-02-19 17:02 UTC, Brent Smith (smitten)
committed Details | Review
script to automate this (1.68 KB, application/xml)
2006-02-19 20:42 UTC, Brent Smith (smitten)
  Details

Description Joachim Noreiko 2006-02-11 17:46:59 UTC
At some point we need to convert the tables that are used in the user guide where variablelists would be clearer and simple. These are mainly in the description of UI elements of the preference tools.

Low priority, something for someone with a wet afternoon who wants to play with XSTL or perl or something.
Comment 1 Brent Smith (smitten) 2006-02-16 04:39:46 UTC
Created attachment 59452 [details] [review]
changes table to variablelist for gconf command options

Here is the first one:  Convert the gconf command line options table to a variablelist

Makes this section much more readable since the width isn't fixed...  Let me know what you think.  I've validated the system-admin-guide.xml after the patch.  looks good
Comment 2 Joachim Noreiko 2006-02-19 10:18:19 UTC
Yup, looks very good.
We need to change the introductory paragraph and remove cross-reference and the heading.

There is a problem with example commands getting justified, but that was present in the table already.
Comment 3 Brent Smith (smitten) 2006-02-19 17:02:30 UTC
Created attachment 59717 [details] [review]
another patch - same as last, except change <para> to <literallayout> to remove justification

This is an updated  patch to take care of the justification by replacing <para> with <literallayout> in the examples.  Also a few other minor fixes.
Comment 4 Brent Smith (smitten) 2006-02-19 20:39:49 UTC
Committed in HEAD.  Leaving the bug open for other tables that should be converted to variable lists.
Comment 5 Brent Smith (smitten) 2006-02-19 20:42:58 UTC
Created attachment 59734 [details]
script to automate this

This is a quick hack to do the conversion for you.  It will only work on tables with two columns and assumes that the children of <entry> are valid children of <listitem>  (which isn't always the case)

The input file should be a file with <table> as the root element
Comment 6 Joachim Noreiko 2006-02-21 15:40:56 UTC
Seems to work nicely.
The biggest problem is that <entry> usually has a <para> in it, and <term> can't.
Yelp doesn't mind, but xmllint does.
If you have time to polish this, there's a few other minor points: could it work on <informaltable> root elements too? and could it either preserve indentation or create some? Something simple like one paragraph per varlistentry element would be fine, for example.
Comment 7 Joachim Noreiko 2006-12-23 16:46:28 UTC
Brief update: I did some messing about with perl and I've got a text file of the converted tables. I just need to get round to replacing them all. Low priority.