Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 449164 - Guides: how to create side-by-side diff-style docs?
Summary: Guides: how to create side-by-side diff-style docs?
Status: RESOLVED CANTFIX
Alias: None
Product: [OLD] Docs on www.gentoo.org
Classification: Unclassified
Component: New Documentation (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Docs Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2012-12-29 11:15 UTC by Michał Górny
Modified: 2013-11-22 22:59 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2012-12-29 11:15:25 UTC
I'm working on 'python-r1 by examples' guide and I wanted to create it in style of side-by-side diffs.

To be more exact, I want to show the python.eclass ebuild in one column, and python-r1 ebuild in the second column like:

| python.eclass ebuild           | python-r1 ebuild              |
|                                |                               |
| PYTHON_DEPEND=...              | PYTHON_COMPAT=...             |
...

which would be really helpful to explain migration from one eclass to another. Is it possible to create something like this in our guide format?

So far, I have tried using <pre/> in table but that ain't permitted by the DTD.
Comment 1 Sven Vermeulen (RETIRED) gentoo-dev 2012-12-29 12:07:54 UTC
Beyond doing this in a single <pre>...</pre> one, I don't see an immediate way to handle this without loosing a preserved whitespace.

I think allowing a <pre> in a table wouldn't make much sense as it might make things very ugly; however, perhaps we could just allow <code> or <tt> so that you can use whitespace-preserved stuff in a table.

Another possibility would be to use our wiki, which allows for more formatting than GuideXML.
Comment 2 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2012-12-29 18:01:29 UTC
(In reply to comment #1)
> Beyond doing this in a single <pre>...</pre> one, I don't see an immediate
> way to handle this without loosing a preserved whitespace.
> 
> I think allowing a <pre> in a table wouldn't make much sense as it might
> make things very ugly; however, perhaps we could just allow <code> or <tt>
> so that you can use whitespace-preserved stuff in a table.

Well, a quick try with gorg shows it doesn't look best but I'd say it's acceptable [1]. It would be great if the table was stretched to the width of content area, and the code blocks were of same width by default; but so far, the worst thing is the numbering which results in repeating '1.1'.

[1]:http://dev.gentoo.org/~mgorny/python-r1/examples.html

> 
> Another possibility would be to use our wiki, which allows for more
> formatting than GuideXML.

I'd rather keep all the docs in a single place, and mediawiki would be the last resort to me. I'd rather write plain HTML.
Comment 3 nm (RETIRED) gentoo-dev 2013-11-22 22:59:13 UTC
seems to be dead/moot. closing.