| 1 |
Ühel kenal päeval, R, 06.04.2012 kell 06:13, kirjutas Sven Vermeulen: |
| 2 |
> On Thu, Apr 05, 2012 at 08:41:57PM -0700, Brian Dolbec wrote: |
| 3 |
> > It is getting rather late to be just starting research for a project |
| 4 |
> > proposal when the deadline to submit is only 15 hours from now. |
| 5 |
> > |
| 6 |
> > The contact person for that is not online at the moment. So unless you |
| 7 |
> > already know what you need to do, I am afraid that you probably will not |
| 8 |
> > get the information needed to submit a successful proposal. |
| 9 |
> |
| 10 |
> The deadline is indeed quite soon. Nevertheless, some resources and |
| 11 |
> information about the project suggestion... |
| 12 |
> |
| 13 |
> A while ago, work was done on a Django-based framework that could (would) |
| 14 |
> provide a new interface, layout but also new features on the Gentoo website. |
| 15 |
> This project was called Okupy [1]. Due to lack of resources and the |
| 16 |
> necessary push in the organization, Okupy is left as a "in-development" |
| 17 |
> project. |
| 18 |
> |
| 19 |
> [1] http://blogs.gentoo.org/tampakrap/tag/okupy/ |
| 20 |
> |
| 21 |
> In this project suggestion, the idea is to enhance Okupy to provide |
| 22 |
> conversion of our internal documentation format (GuideXML and the related |
| 23 |
> XML formats) into other formats (beyond XHTML, which it already supports). |
| 24 |
> ePub has been asked a few times (especially for the Gentoo Handbook), PDF as |
| 25 |
> well. |
| 26 |
|
| 27 |
One should also look at Sphinx documentation generator [1] (the one that |
| 28 |
Python and most of its newer project use). It has cool side features |
| 29 |
like LaTeX/HTML/ePub (plus some extra) output generators and it takes |
| 30 |
ReST formatted text as input. |
| 31 |
It also supports some cool features like sourcecode syntax colouring, |
| 32 |
automatic indexing and cross referencing, search (for html), math |
| 33 |
typesetting using TeX syntax with multiple output backends (MathML or |
| 34 |
PNG), just to name a few... |
| 35 |
|
| 36 |
Also there's at least one book for sale on Amazon (that I know) that's |
| 37 |
published with the help of Sphinx (just search this weeks or last weeks |
| 38 |
Sphinx mailinglist where the author/publisher announced it and also |
| 39 |
complained about some minor issue and its workaround) |
| 40 |
|
| 41 |
[1] http://sphinx.pocoo.org/ |
| 42 |
|
| 43 |
> To integrate this in Okupy also means to verify if these translations are |
| 44 |
> fast and powerful enough to do on a dynamically generated site. If not, |
| 45 |
> you'll need to look into caching (well, let's say you need to. period.) and |
| 46 |
> perhaps even pregeneration of the documents (especially for PDF as most |
| 47 |
> conversion methods are CPU intensive). |
| 48 |
> |
| 49 |
> If this looks too easy for a GSoC project, consider integrating other |
| 50 |
> document formats as master (like wiki, docbook, ...) which will have more |
| 51 |
> consequences, as Okupy currently uses the XML files as the only master. But |
| 52 |
> accepting input from other formats allows us to find more documentation |
| 53 |
> providers for our documentation repository. |
| 54 |
> |
| 55 |
> Wkr, |
| 56 |
> Sven Vermeulen |
| 57 |
> |
| 58 |
|
| 59 |
Päikest, |
| 60 |
Priit Laes :) |
Archives