The advantage of the wiki version is that people will actually edit and improve it. To prove my point, a few sentences from: http://www.nhforge.org/doc/nh/en/index.html "Contrast this with the usual Java model where an unreferenced object is garbage collected." "This manual uses lowercase HQL keywords. Some users find queries with uppercase keywords more readable, but we find this convention ugly when embedded in Java code." "A Java class name embedded in the where clause will be translated to its discriminator value. " "The Hibernate code generator may be used to generate skeletal Javaimplementation classes from a Hibernate mapping file."
These docs were ported back in september 2005 we still have references to Java and Hibernate! The docbook format is obviously not working as a living reference document! On Wed, Oct 1, 2008 at 12:39 PM, Fabio Maulo <[EMAIL PROTECTED]> wrote: > Yes was fixed but we need to upgrade to CS2008.5 final release and it mean > backup, upgrade etc. > For separate pages, if you want, you can use the Know version of the > doc-wiki. > There I separate each chapter: > http://knol.google.com/k/fabio-maulo/nhibernate/1nr4enxv3dpeq/21# > The disvantage to have only the wiki version is that it can't be converted > to something else than wiki. > With docBook you can create single-html, multi-html, PDF, chm and in theory > each page of the wiki too. > To edit the doc in docBook format we have a license of Oxygen to edit in > WYSIWYG way but... we must convert our documentation to DocBook5 format. > Perhaps Pierre and Tobes can give us some advise about which is the best doc > editor (they write NHiA in some format). > > 2008/10/1 Will Shaver <[EMAIL PROTECTED]> >> >> Ok, yes it is there, but not in wiki format. The wiki formatted >> reference doesn't have many of the sections in the current >> docbook/static version. >> >> So basically what I'm hearing is that we need someone (probably me) to >> grab the most current docbook version and convert that to this wiki. >> At that point I'd recommend removing the docbook from the repo or >> freezing it etc. We can review the Hibernate version for ideas if >> needed, but keeping it online for easy editing seems more effective. >> >> Should I make one big "Page" or separate out each section into a >> separate "Page"? >> >> Still no fix on the revision history "revised by" bug? >> >> -Will >> >> On Wed, Oct 1, 2008 at 12:06 PM, Fabio Maulo <[EMAIL PROTECTED]> wrote: >> > 2008/10/1 Will Shaver <[EMAIL PROTECTED]> >> >> >> >> Are we going to move the documentation here: >> >> >> >> http://www.hibernate.org/hib_docs/nhibernate/1.2/reference/en/html_single/ >> >> to nhforge.org? >> > >> > http://www.nhforge.org/wikis/reference2-0en/preface.aspx click on Here >> > static reference to go to >> > http://www.nhforge.org/doc/nh/en/index.html >> > >> >> >> >> Can we make a copy, label it 2.0, and go to town on it? >> > >> > As you can see it was labeled as 2.0. >> > >> >> >> >> There are a >> >> number of things that need cleaning up / revising. I'm willing to work >> >> on them as I come across them... >> > >> > The documentation was written using DocBook and it is part of the >> > branch/trunk. >> > You can find it in nhibernate\doc\reference\modules >> > >> >> >> >> Do we need someone to do the work of transferring this document into >> >> the nhforge wiki? >> > >> > Puf..... sure. I start the work but it need long time >> > http://www.nhforge.org/wikis/reference2-0en/default.aspx >> > >> > In the right "Pages" is the table of content. >> > >> >> >> >> Is the verison in the trunk more up-to-date than the >> >> online one? >> > >> > In trunk it is the same of that published in Knol and in NHforge wiki. >> > >> >> >> >> Should I do the work to copy it over? >> > >> > Anything you have time to do with the documentation is welcome. >> > I'm not sure about what is better... do the work in DocBook and then >> > copy to >> > the wiki or directly to the wiki (each have pros/cons). >> > The wiki can be maintained actualized by everyone. Maintain the DocBook, >> > apparently, is not part of committers interests (facts speak by they >> > self). >> > In the trunk we need to add the doc of some available new features; some >> > one >> > can be copied from H3.2 doc but some others (for example all added in >> > Criteria API) are NH specific features. >> > -- >> > Fabio Maulo >> > > > > > -- > Fabio Maulo >
