Bug 647 - X specs should be in open formats
Summary: X specs should be in open formats
Status: RESOLVED FIXED
Alias: None
Product: xorg
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: All All
: medium normal
Assignee: Xorg Project Team
QA Contact: Xorg Project Team
URL:
Whiteboard:
Keywords:
: 9866 (view as bug list)
Depends on:
Blocks:
 
Reported: 2004-05-20 09:10 UTC by Adam Jackson
Modified: 2011-10-15 15:58 UTC (History)
7 users (show)

See Also:
i915 platform:
i915 features:


Attachments

Description Adam Jackson 2004-05-20 09:10:26 UTC
Roughly 1/6 of xorg/xc/doc/specs is FrameMaker files, for example.  And ISTR
seeing MS Word docs in there at one point.

Advantages: open formats are platform independent and generally easier to
maintain in CVS.
Comment 1 Egbert Eich 2004-05-27 22:30:36 UTC
That's true and we are looking for people to help on the conversion. Would you
like to help? 
The first thing we would need is a plan to follow:
The framemaker (and groff) files need to be converted to a format that can be
used to create different kinds of documents (XML would be a plausible choice),
the conversion (hopefully mostly automatic) would then have to be reviewed.
The format that we decide on should be easy to handle. Document writing is a
piece of the software development equation that is often ignored as developers
prefer writing code over documentation. Therefore making it an unpeasant
experience to create new documentation will most likely not produce them more
documentation.
Comment 2 Alan Coopersmith 2004-05-30 05:45:45 UTC
When this was discussed at the Xorg arch task force a while ago, there were a 
couple of people with FrameMaker licenses who offered to use it to read in the
existing docs and export to SGML/XML so it could be converted to a more useful 
format.  There's also a similar set of work proposed for the man pages - though
that should be simpler since there's just the one format to convert and tools
to do most of the work ( http://www.catb.org/~esr/doclifter/ ).
Comment 3 Adam Jackson 2004-09-03 19:59:16 UTC
this one shouldn't be assigned to me, i'm not actively working on it.
Comment 4 Eamon Walsh 2007-02-13 20:55:57 UTC
*** Bug 9866 has been marked as a duplicate of this bug. ***
Comment 5 Daniel Stone 2007-02-27 01:23:32 UTC
Sorry about the phenomenal bug spam, guys.  Adding xorg-team@ to the QA contact so bugs don't get lost in future.
Comment 6 Alan Coopersmith 2007-11-20 17:54:31 UTC
http://people.freedesktop.org/~alanc/xkb/ has exports of the XKB docs from
Framemaker to other formats that I did a while ago if anyone wants to tackle
those.
Comment 7 Alan Coopersmith 2011-05-26 17:17:21 UTC
I think Matt's fixed this now.   (There's still some nroff, but that's at
least open, unlike Frame.)
Comment 8 Matt Dew 2011-05-27 12:25:32 UTC
There should be ZERO framemaker files left in the tree. Marc Balmer and I discussed this and he converted the into basic xml and I converted those into docbook.  They still need polishing (on the list, help would not be turned down) though.

 There are two troff docs left in the tree.  Xt and one other, the name of which I've forgotten.


Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.