Account Options

  1. Sign in
The old Google Groups will be going away soon.
Switch to the new Google Groups.
Google Groups Home
« Groups Home
Neo4j uses asciidoc
There are currently too many topics in this group that display first. To make this topic appear first, remove this option from another topic.
There was an error processing your request. Please try again.
flag
  3 messages - Collapse all  -  Translate all to Translated (View all originals)
The group you are posting to is a Usenet group. Messages posted to this group will make your email address visible to anyone on the Internet.
Your reply message has not been sent.
Your post was successful
 
From:
To:
Cc:
Followup To:
Add Cc | Add Followup-to | Edit Subject
Subject:
Validation:
For verification purposes please type the characters you see in the picture below or the numbers you hear by clicking the accessibility icon. Listen and type the numbers you hear
 
Anders Nawroth  
View profile  
 More options Mar 30 2011, 8:10 am
From: Anders Nawroth <and...@neotechnology.com>
Date: Wed, 30 Mar 2011 14:10:03 +0200
Local: Wed, Mar 30 2011 8:10 am
Subject: Neo4j uses asciidoc
Hi!

The Neo4j graph database project uses Asciidoc, and the output is
published here:
http://docs.neo4j.org/

The build process is rather complex, with the master documents and
configuration stored here:
https://github.com/neo4j/server/tree/master/manual

We also have our own filter to include code snippets:
https://github.com/neo4j/server/tree/master/manual/src/bin/resources/...
The syntax we use may look strange, but it's very readable. The filter
is tailored for our build setup, but it shouldn't be hard to change it
to fit other cases.

We want to keep documentation and code close to each other, so each
project has it's own documents, and that gets pulled together by the
Maven build tool and pushed onto some scripting that executes asciidoc/a2x.

So for example the code snippets on this page:
http://docs.neo4j.org/chunked/snapshot/indexing-create.html
are included from this document:
https://github.com/neo4j/graphdb/blob/master/lucene-index/src/docs/de...
The code included lives here:
https://github.com/neo4j/graphdb/blob/master/lucene-index/src/test/ja...
and is tested on each commit.

I just thought this could be interesting to someone on this list :-) And
of course for the list of projects using Asciidoc!

BTW, we're still on version 8.6.3 - I hope to upgrade in a couple of
weeks. So I haven't looked into how filters are handled in 8.6.4 yet.

/anders


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.
Stuart Rackham  
View profile  
 More options Apr 11 2011, 2:29 am
From: Stuart Rackham <srack...@gmail.com>
Date: Mon, 11 Apr 2011 18:29:31 +1200
Local: Mon, Apr 11 2011 2:29 am
Subject: Re: Neo4j uses asciidoc
Hi Anders

On 31/03/11 01:10, Anders Nawroth wrote:

> Hi!

> The Neo4j graph database project uses Asciidoc, and the output is published here:
> http://docs.neo4j.org/

> The build process is rather complex, with the master documents and configuration
> stored here:
> https://github.com/neo4j/server/tree/master/manual

Very impressive, it amazes me what people get up to with AsciiDoc.

> We also have our own filter to include code snippets:
> https://github.com/neo4j/server/tree/master/manual/src/bin/resources/...
> The syntax we use may look strange, but it's very readable. The filter is
> tailored for our build setup, but it shouldn't be hard to change it to fit other
> cases.

It's a nice solution to your snippet problem, can it be installed using the new
Filter Plugins mechanism (http://www.methods.co.nz/asciidoc/filters.html)? I'm
certain that a lot of other users would be interested in using it.

I've added it the list on the AsciiDoc home page -- let me know if it needs editing.

> BTW, we're still on version 8.6.3 - I hope to upgrade in a couple of weeks. So I
> haven't looked into how filters are handled in 8.6.4 yet.

Probably answers my Filter Plugins question.

Cheers, Stuart


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.
Anders Nawroth  
View profile  
 More options Apr 13 2011, 8:21 am
From: Anders Nawroth <and...@neotechnology.com>
Date: Wed, 13 Apr 2011 14:21:17 +0200
Local: Wed, Apr 13 2011 8:21 am
Subject: Re: Neo4j uses asciidoc
Hi!

On 04/11/2011 08:29 AM, Stuart Rackham wrote:

> Hi Anders

> On 31/03/11 01:10, Anders Nawroth wrote:
>> Hi!

>> The Neo4j graph database project uses Asciidoc, and the output is
>> published here:
>> http://docs.neo4j.org/

>> The build process is rather complex, with the master documents and
>> configuration
>> stored here:
>> https://github.com/neo4j/server/tree/master/manual

> Very impressive, it amazes me what people get up to with AsciiDoc.

Well, I'm amazed by AsciiDoc :-) It handles a lot of use cases well, and
some other cases are still possible at least.

>> We also have our own filter to include code snippets:
>> https://github.com/neo4j/server/tree/master/manual/src/bin/resources/...

>> The syntax we use may look strange, but it's very readable. The filter is
>> tailored for our build setup, but it shouldn't be hard to change it to
>> fit other
>> cases.

> It's a nice solution to your snippet problem, can it be installed using
> the new Filter Plugins mechanism
> (http://www.methods.co.nz/asciidoc/filters.html)? I'm certain that a lot
> of other users would be interested in using it.

At the moment we're under too heavy load to fix this (and even to
upgrade to the new AsciiDoc version) but maybe we'll get around doing
that eventually. Inbetween the code is open source so anyone who's more
into the details regarding AsciiDoc can have a look at it :-)

> I've added it the list on the AsciiDoc home page -- let me know if it
> needs editing.

Looks perfect to me.

>> BTW, we're still on version 8.6.3 - I hope to upgrade in a couple of
>> weeks. So I
>> haven't looked into how filters are handled in 8.6.4 yet.

> Probably answers my Filter Plugins question.

Exactly.

/anders


 
You must Sign in before you can post messages.
To post a message you must first join this group.
Please update your nickname on the subscription settings page before posting.
You do not have the permission required to post.
End of messages
« Back to Discussions « Newer topic     Older topic »