On 02/14/2012 02:33 PM, Michael Meeks wrote:
On Tue, 2012-02-14 at 23:07 +1030, Josh Heidenreich wrote:
What is the markup format to be used in the READMEs?
It's a loose copy of the wikimedia syntax used in the wiki, so:
- Paragraphs are separated by a blank line.
- Headings are in the form
Stephan Bergmann wrote:
I wonder whether there's not some package to translate one of those
newfangled lightweight markups into HTML which could be reused here?
Sure - e.g.
http://search.cpan.org/~rwstauner/Pod-Markdown-1.20/lib/Pod/Markdown.pm
or
http://pypi.python.org/pypi/Markdown
On Tue, 2012-02-14 at 23:01 +0100, Stephan Bergmann wrote:
On 02/14/2012 10:39 PM, Josh Heidenreich wrote:
Do we need licence blocks in a README? Can we just write the licence in
on all pages generated by the script?
My (naive?) take on it is that, technically, all the files committed to
On 02/03/2012 03:56 AM, Josh Heidenreich wrote:
It uses cgit to download the README or readme.txt files in all of the
top-level directories, and it generates some HTML files for easy
viewing. The first paragraph (everything before an empty line) is
considered the short description, and is shown
Thorsten, Stephan, List,
nope, it's a manual process that I run every once in a while.
Doxygen itself is rather heaviweight, so you really don't want to
run that on a server, let alone for every commit.
Can it be run standalone, without the rest of doxygen? Could it be run
every commit in that
On 02/14/2012 01:37 PM, Josh Heidenreich wrote:
What is the markup format to be used in the READMEs?
It's a loose copy of the wikimedia syntax used in the wiki, so:
- Paragraphs are separated by a blank line.
- Headings are in the form == heading == (without the quotes)
- Links to modules are
Josh Heidenreich wrote:
Can it be run standalone, without the rest of doxygen? Could it be run
every commit in that case until the READMEs stablalise a bit (i.e. I
get something in there for every module as a starting point for this
project)
In principle yes, with the current script - nope.
On Tue, 2012-02-14 at 23:07 +1030, Josh Heidenreich wrote:
What is the markup format to be used in the READMEs?
It's a loose copy of the wikimedia syntax used in the wiki, so:
- Paragraphs are separated by a blank line.
- Headings are in the form == heading == (without the quotes)
- Links
Stephan Bergmann wrote:
So no way to have a (license) comment at the head of a README?
Sure - just invent a markup for it on the spot. :)
Cheers,
-- Thorsten
pgpE3XifXWBiz.pgp
Description: PGP signature
___
LibreOffice mailing list
hi,
So no way to have a (license) comment at the head of a README?
Do we need licence blocks in a README? Can we just write the licence in on
all pages generated by the script?
Also, if you do need a licence block, it can't be the first paragraph of
the readme, that's for a summary.
Maybe one
On 02/14/2012 10:39 PM, Josh Heidenreich wrote:
Do we need licence blocks in a README? Can we just write the licence in
on all pages generated by the script?
My (naive?) take on it is that, technically, all the files committed to
the git repo are source files that should have a legal header.
So, wow again for this great work - I couldn't resist, and merged
that up with the existing doxygen documentation, result is here:
http://docs.libreoffice.org/
Pushed now to solenv/bin/mkdocs.sh - thanks again!
Cheers,
-- Thorsten
pgpLbm6gctRk7.pgp
Description: PGP signature
Thorsten,
That stuff is currently generated by a little shell script - I'm not
particularly attached to it, and wouldn't mind perl or python there,
but php so far is not used throughout the build system, maybe we can
avoid it here, too?
At any rate, rather ugly conversion of your beautiful
Josh Heidenreich wrote:
Also, does it update after every commit? And does a change to the
generator do an update too?
Hi Josh,
nope, it's a manual process that I run every once in a while.
Doxygen itself is rather heaviweight, so you really don't want to
run that on a server, let alone for
Josh Heidenreich wrote:
You can see the result here:
http://thejosh.info/libreoffice/module_readmes/
So, wow again for this great work - I couldn't resist, and merged
that up with the existing doxygen documentation, result is here:
http://docs.libreoffice.org/
That stuff is currently
Hi Josh,
On Fri, 2012-02-03 at 13:26 +1030, Josh Heidenreich wrote:
I was bored while waiting for LibO to compile, and I was taking a look
at the wiki docs for development. I found a page Code Overview, but
it looks really out of date.
It is ! :-)
On 02/03/2012 03:56 AM, Josh Heidenreich wrote:
Now of course all we need is to add more README files.
module configmgr has configmgr/source/README, so either improve the
script or move the file... :)
Stephan
___
LibreOffice mailing list
Mike, *,
What would be really sexy (apart from getting your script running on a
TDF server and linked from the wiki etc. etc.) - would be if we could
transfer what little information we have from the Code_Overview into
README files. Any chance you could clone the git repo from
Hi,
I was bored while waiting for LibO to compile, and I was taking a look
at the wiki docs for development. I found a page Code Overview, but
it looks really out of date.
(http://wiki.documentfoundation.org/Development/Code_Overview). Then I
thought maybe I should update it, and then I thought
19 matches
Mail list logo
