Hi Niclas, Works like a charm now! :-) Well done!
What is your rationale for separating 'recipes', 'reference', 'userguide' and 'website' - it seems to me that they could be main parts of a single merged coherent 'Qi4j documentation' since they all follow the same layout. Thanks for working on this. When documentation falls more into place, we should be able to attract more people and thus get more help also to advance qi4j further. Cheers, Marc On 2011-12-11, at 05.01, Niclas Hedhman wrote: > I think I have fixed your problem now. > > I have also made an 'install' of a "snippet" filter (from Neo4j, which > I hope we can improve), which copies from qi4j-sdk/buildSrc/src/bin to > $HOME/.asciidoc/filters/snippet/. I have not tested whether it works > properly or not. PYTHON developers, please help getting the snippet.py > to support "pause/resume" pattern which is changed to one or a couple > of lines of " : " (indented colon). > > I have added src/docs/index.txt placeholders for all modules, so no > excuse to not start writing ;-) > > Finally, brought in some more content from Qi4j website. > > > Cheers > Niclas > > On Sun, Dec 11, 2011 at 12:00 AM, Niclas Hedhman <[email protected]> wrote: >> I am actually quite happy with the logo, but perhaps that is just me... >> The "essence" of Qi4j is an Holistic Approach, Top down, to develop >> rich domain model applications. Not the easiest concept to abstract >> into a simple logo. >> >> So, some directory is not being created in the Documentaion.groovy >> script. I am heading to bed now, but will spend a couple of minutes on >> it in the morning, if you don't beat me to it. >> >> >> >> On Sat, Dec 10, 2011 at 7:24 PM, Marc Grue <[email protected]> wrote: >>> Hi Niclas, >>> >>> I would like to help if I can. I can look into structuring the material if >>> you like. I might be able to help with some css too. Can you give me some >>> clues of where to start (I can look for more pictures from the current site >>> as a start)? >>> >>> I was thinking of maybe revamping the Qi4j logo to catch the essence of >>> Qi4j! I think neo4j did a good job with their logo, but they have a much >>> simpler perspective: nodes and relationships basically. What is the essence >>> of Qi4j? If it's something about a composite oriented paradigm and >>> interfaces, it could be cool to somehow capture that graphically in a >>> logo... WDYT? If we did a new logo, we could also start out with a new >>> style matching that new "identity". Why not now with version 2.0? >>> >>> I quickly did a >>> >>> git pull >>> ./gradlew clean manuals >>> >>> and got the following error: >>> >>> :org.qi4j.manual:recipes >>> asciidoc: FAILED: unexpected error: >>> asciidoc: ------------------------------------------------------------ >>> Traceback (most recent call last): >>> File "/usr/local/bin/asciidoc", line 5945, in asciidoc >>> writer.open(outfile, reader.bom) >>> File "/usr/local/bin/asciidoc", line 4372, in open >>> self.f = open(fname,'wb+') >>> IOError: [Errno 2] No such file or directory: >>> '/Users/marcgrue/github/qi4j/qi4j-sdk/manual/build/tmp/docs/recipes/xdoc-temp.xml' >>> asciidoc: ------------------------------------------------------------ >>> >>> Have to go play concerts now, but I'll try do a fresh download of the >>> qi4j-sdk when I get home tonight and try again. >>> >>> Have you checked out the _new_ Google groups? I really like them, and would >>> suggest to move this list over there. It would become more flexible to >>> extensively format posts with code formatting, inline pictures etc... >>> Beside the sugarcoating it can be helpful too in many cases, I think. >>> >>> I'll then also upload my dci-cargo code... >>> >>> Cheers, >>> Marc >>> >>> On 2011-12-09, at 18.32, Niclas Hedhman wrote: >>> >>>> As you perhaps know, I am getting AsciiDoc toolchain to be used in >>>> Qi4j and integrated into the build system. Neo's build was very messy, >>>> due to the use of Maven. I have opted for doing it directly in Gradle, >>>> and not at all that hard. See the Groovy class; >>>> qi4j-sdk/buildSrc/src/main/groovy/org/qi4j/gradle/plugin/documentation/Documentation.groovy >>>> >>>> AsciiDoc documentation is available at; >>>> http://www.methods.co.nz/asciidoc/index.html >>>> >>>> ./gradlew clean manuals >>>> >>>> in the manual/ project will build the documentation. It is required >>>> that asciidoc tool chain to be installed on your OS. See above docs >>>> for that. I will try to make this automatic in the future. >>>> >>>> I have started to port the existing content to qi4j-sdk repository. I >>>> want to keep as much content as near the 'logical source' as possible, >>>> but some stuff are heading into manual/ at the moment, but things will >>>> eventually move around. Any content that has source code in it, should >>>> sit in a Gradle project and the source be actual, compilable and >>>> "snipped" into the documentation, to ensure it compiles and evolves >>>> with changes. >>>> >>>> Right now, I could use a hand; >>>> >>>> * Images to be pulled in from www.qi4j.org >>>> >>>> * Styling, if someone knows how to get the CSS (possibly XSLT as >>>> well) to look decent. >>>> >>>> * Structure up the "manuals"... I am thinking website, userguide (a >>>> book), recipes (how-to, articles, tutorials), reference (javadoc >>>> initially) >>>> >>>> * More articles and other content. >>>> >>>> * Figure out how to make a better "snippet" system, than Neo has; >>>> >>>> >>>> The last needs some explanation. Assume a typical source file, with my >>>> "snippet" markers; >>>> >>>> /* >>>> * Copyright (c) 2007, Rickard Öberg. All Rights Reserved. >>>> * >>>> * Licensed under the Apache License, Version 2.0 (the "License"); >>>> * you may not use this file except in compliance with the License. >>>> * You may obtain a copy of the License at >>>> http://www.apache.org/licenses/LICENSE-2.0 >>>> * Unless required by applicable law or agreed to in writing, software >>>> * distributed under the License is distributed on an "AS IS" BASIS, >>>> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. >>>> * See the License for the specific language governing permissions and >>>> * limitations under the License. >>>> * >>>> */ >>>> >>>> package org.qi4j.api.property; >>>> >>>> import org.qi4j.api.common.AppliesTo; >>>> import org.qi4j.api.common.AppliesToFilter; >>>> import org.qi4j.api.injection.scope.State; >>>> >>>> import java.lang.reflect.InvocationHandler; >>>> import java.lang.reflect.Method; >>>> >>>> /** >>>> * Generic mixin for properties. >>>> */ >>>> // SNIPPET START: PropertyMixin >>>> @AppliesTo( { PropertyMixin.PropertyFilter.class } ) >>>> public final class PropertyMixin >>>> implements InvocationHandler >>>> { >>>> @State private StateHolder state; >>>> // SNIPPET PAUSE: PropertyMixin >>>> >>>> public Object invoke( Object proxy, Method method, Object[] args ) >>>> throws Throwable >>>> { >>>> return state.propertyFor( method ); >>>> } >>>> >>>> public static class PropertyFilter >>>> implements AppliesToFilter >>>> { >>>> public boolean appliesTo( Method method, Class<?> mixin, >>>> Class<?> compositeType, Class<?> modifierClass ) >>>> { >>>> return Property.class.isAssignableFrom( method.getReturnType() >>>> ); >>>> } >>>> } >>>> // SNIPPET RESUME: PropertyMixin >>>> } >>>> // SNIPPET START: PropertyMixin >>>> >>>> >>>> would produce; >>>> >>>> @AppliesTo( { PropertyMixin.PropertyFilter.class } ) >>>> public final class PropertyMixin >>>> implements InvocationHandler >>>> { >>>> @State private StateHolder state; >>>> : >>>> : >>>> } >>>> >>>> >>>> Hope That Helps someone to Help Me. ;-) >>>> -- >>>> Niclas Hedhman, Software Developer >>>> http://www.qi4j.org - New Energy for Java >>>> >>>> I live here; http://tinyurl.com/3xugrbk >>>> I work here; http://tinyurl.com/6a2pl4j >>>> I relax here; http://tinyurl.com/2cgsug >>>> >>>> _______________________________________________ >>>> qi4j-dev mailing list >>>> [email protected] >>>> http://lists.ops4j.org/mailman/listinfo/qi4j-dev >>> >>> >>> _______________________________________________ >>> qi4j-dev mailing list >>> [email protected] >>> http://lists.ops4j.org/mailman/listinfo/qi4j-dev >> >> >> >> -- >> Niclas Hedhman, Software Developer >> http://www.qi4j.org - New Energy for Java >> >> I live here; http://tinyurl.com/3xugrbk >> I work here; http://tinyurl.com/6a2pl4j >> I relax here; http://tinyurl.com/2cgsug > > > > -- > Niclas Hedhman, Software Developer > http://www.qi4j.org - New Energy for Java > > I live here; http://tinyurl.com/3xugrbk > I work here; http://tinyurl.com/6a2pl4j > I relax here; http://tinyurl.com/2cgsug > > _______________________________________________ > qi4j-dev mailing list > [email protected] > http://lists.ops4j.org/mailman/listinfo/qi4j-dev _______________________________________________ qi4j-dev mailing list [email protected] http://lists.ops4j.org/mailman/listinfo/qi4j-dev
