Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 457072 - Syntax enhancement: free-purpose 'colored' boxes
Summary: Syntax enhancement: free-purpose 'colored' boxes
Status: RESOLVED OBSOLETE
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal enhancement (vote)
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2013-02-13 11:16 UTC by Michał Górny
Modified: 2014-11-15 11:01 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 2013-02-13 11:16:46 UTC
I'd like to put Python devguide to devmanual. For that reason, I'd like to request an improvement in devmanual syntax.

I'd like to be able to create a sub-sections/boxes with information dedicated to a particular group of people. Mostly like:

  Section
  ---------

  Normal stuff.

  +--------
  | python.eclass differences
  | ...
  +--------

  +-------
  | Rationale
  | ...
  +-------

with each 'python.eclass differences' being a box of one color, and 'Rationale' of another, so that people could be able to find them easily within various sections.
Comment 1 Markos Chandras (RETIRED) gentoo-dev 2013-02-13 11:48:09 UTC
I certainly don't have the knowledge to do such thing. So lets hope someone in the devmanual@ can do that or you can provide a patch of course :). I will cc a couple of people that may know about these things.
Comment 2 Ben de Groot (RETIRED) gentoo-dev 2013-02-13 12:57:51 UTC
No need to CC me, I'm on devmanual@.

I still say we should migrate devmanual to rst + sphinx, and then with the proper stylesheet this should be no problem. I don't know (and don't care to find out) how to do it with the legacy xml system.
Comment 3 Michał Górny archtester Gentoo Infrastructure gentoo-dev Security 2013-02-13 14:25:50 UTC
(In reply to comment #2)
> I still say we should migrate devmanual to rst + sphinx, and then with the
> proper stylesheet this should be no problem. I don't know (and don't care to
> find out) how to do it with the legacy xml system.

+1. Is there an agreement over that?
Comment 4 Markos Chandras (RETIRED) gentoo-dev 2013-02-13 14:28:41 UTC
(In reply to comment #3)
> (In reply to comment #2)
> > I still say we should migrate devmanual to rst + sphinx, and then with the
> > proper stylesheet this should be no problem. I don't know (and don't care to
> > find out) how to do it with the legacy xml system.
> 
> +1. Is there an agreement over that?

no as far as I know
Comment 5 Diego Elio Pettenò (RETIRED) gentoo-dev 2013-02-13 14:32:23 UTC
As long as somebody feels like doing the work in full, I don't care which format it is going to be migrated to, but it really has to be migrated.

I started with DocBook, but a few years after using it I'm skeptical myself (okay it works nicely for eBook building but it's a lot of work for that anyway).

I haven't tried/looked at Sphinx yet, and I have a personal dislike for the original RST format, but if it's an improvement, I'd say go for it. Just please don't name all the files "text.rst".
Comment 6 Markos Chandras (RETIRED) gentoo-dev 2014-11-15 11:01:51 UTC
The theme has changed recently. So I am marking this as obsolete. If the current theme does not satisfy you, re-open the bug