Permalink
Browse files

This commit was manufactured by cvs2svn to create tag 'rc_0-99-3-0'.

SVN: tags/rc_0-99-3-0@1738
  • Loading branch information...
1 parent c6224c0 commit 51402aeb7f6d8c91272ed15dbd4328b8a5a0cf47 (no author) committed Oct 5, 2005
Showing 709 changed files with 0 additions and 150,785 deletions.
View
@@ -1 +0,0 @@
-build
View
@@ -1,3 +0,0 @@
-rem Open the file "build\build.log" to read NAnt's output
-if not exist build md build
-NAnt -D:vshik.installed=true clean build > build\build.log
@@ -1,60 +0,0 @@
-
- How To Build NHibernate Documentation
-
-================================================================================
-Introduction
-================================================================================
-
-This is the source files used to generate the NHibernate Documentation.
-These files (in /doc/src/) are represented as DocBook (xml) files.
-
-To build the documentation, you have to install some tools; and after that,
-you can simply run "Build.bat" (the result will be in /doc/build/).
-
-
-================================================================================
-Required DLLs and EXEs
-================================================================================
-Download the files at ftp://ftp.zlatkovic.com/pub/libxml/ (or somewhere else ;)
-
-Create a "tools" directory (you can use any directory).
-Add these files to the "tools" directory:
-
-iconv.dll - from iconv-1.9.1.win32.zip
-libexslt.dll - from libxslt-1.1.12.win32.zip
-libxml2.dll - from libxml2-2.6.15.win32.zip
-libxslt.dll - from libxslt-1.1.12.win32.zip
-xmlcatalog.exe - from libxml2-2.6.15.win32.zip
-xmllint.exe - from libxml2-2.6.15.win32.zip
-xsltproc.exe - from libxslt-1.1.12.win32.zip
-zlib1.dll - from zlib-1.2.1.win32.zip
-
-Add the "tools" directory to your %PATH% so the NAnt build file can use them.
-
-
-================================================================================
-Quick Start
-================================================================================
-Read this article on Code Project (by Jim Crafton)
- "Documention with DocBook on Win32"
- http://www.codeproject.com/winhelp/docbook_howto.asp
-
-
-================================================================================
-Docbook Manual
-================================================================================
-Can be downloaded at http://docbook.org/tdg/en/tdg-en-html-2.0.10.zip
-Can be viewed (online) at
-http://www.oasis-open.org/docbook/documentation/reference/html/docbook.html
-
-
-================================================================================
-Docbook XSL Guide
-================================================================================
-Can be viewed at http://www.sagehill.net/docbookxsl/index.html
-
-
-================================================================================
-URL for htmlhelp parameters
-================================================================================
-http://docbook.sourceforge.net/release/xsl/snapshot/doc/html/
View
@@ -1,211 +0,0 @@
-
-NOTE: This file contains what should be done for the documentation.
-It is a place to keep ideas/TODOs (to share and not forget them)
-It don't necessarily depict what the doc is/will be.
-
---------------------------------------------------------------------------------
-
-- Complete NHibernate.Tool.hbm2net documentation
-
-- Update the Wiki (contains dynamic stuff; others are moved to this doc)
-
-- Improve the Reference content (=> add more comments in the source code :)
-
-- Generate the PDF version of this documentation
-
-- NH/Readme.html : Presentation (like NH/Home)
- + Integrate the logo (& in this doc)
- + Link to this doc + how to open/install it (html, chm & VS.NET)
- + What to read to quickly get started (how to see NH in action :)
- + Add a "readme.txt" referring to the html version
-- NHC/readme.html + tell that the doc is in NH
-
---------------------------------------------------------------------------------
-
-Elements (that should be available to the users)
-
-- Installer: (use WiX)
- - Copy NHibernate & NHibernateContrib assemblies + source code
- - Register/Copy VS.NET/CHM help
- - "install" LokateIt Application (+ other QuickStart/Sample) + Add shortcuts
-- Source: VS.NET / Borland / #D / Nant build files + Add-ins
-- Documentation + Reference: CHM file + Integration to VS.NET help
-- Samples: Quick starts in C#, VB.NET, � (for all IDEs and NAnt)
-- Video / Macromedia / SlideShow Demo (Architecture, Working Samples)
- (this is very important for newbies and any person trying to pick an ORM)
-
---------------------------------------------------------------------------------
-
-Notes:
-* Put /doc/html/ online: http://nhibernate.sf.net/documentation/
- - Can put http://nhibernate.sf.net/NHibernate[Contrib].Documentation.html ?!?
- - http://nhibernate.sf.net/documentation/Architecture.html
- - http://nhibernate.sf.net/documentation/reference/NHibernate.ISession.html
- => Don't release it (in zip) ? Or without reference (because heavy...)
-* Can save release versions in sub-dir like /doc/nh0950/
-* Find a way to create links between Documentation (DocBook) & Reference (NDoc)
- - Try relative urls...
-
---------------------------------------------------------------------------------
-
-Legend: (formatted for editors using 4 spaces for tabs)
----------------------
-XXX => YYY z
----------------------
-- XXX is the topic
-- YYY is the name of the xml/html files that contains this topic
-- z is used to track the completion of this topic (9=NotStarted; 0=Complete)
- note that it is rather suggestive ;)
-
-
-
-NHibernate Documentation: (replace "NHibernate : Table of Contents" in Wiki)
--------------------------
-- Legal Information / Terms of Use / Licenses (LGPL & FDL) => Legal.Information 1
-- Documentation Map by Technology + FAQ links (questions to topics to read) => Technology.Map 9
-
-+ Getting Started Preface => Getting.Started 8
- - What's new in NHibernate x.x: Changelog + (backward comp) issues => News 8
- + notes on plans & unachieved features (link to NH Dev on Wiki & Jira)
- + Overview of NHibernate => Overview 8
- - What is an ORM and what is NHibernate (and Hibernate + their link)
- + why using it (for Developers, IT and Business guys)
- + Why not using Dataset, StoredProcs, ... (+ when they should be used)
- + Supported .NET versions: .NET 1.x & 2.0 / CompactFram / Mono
- + First steps => First.Steps 8
- - How to get the lastest release of NHibernate
- - How to quickly learn using NHibernate (links and newbies tips)
- - How to contribute (Code/Doc) + how to report bugs or get support
- (guideline, policy, most needed topics)
- - NHibernate in CVS: How to get it, (sign +) build it and run its tests
- + CruiseControl setup (build+test+release) + doc generation
- - Acknowledgements (NHTeam, Contributors, Tools makers and Supporters) => Acknowledgements 8
- - Document Conventions + Note about DocBook & NDoc => Document.Conventions 9
-
-+ Inside NHibernate (+ UML diagrams) Preface => Inside.NHibernate 8
- - Development Standards => Development.Standards 8
- + WorkFlow: What NHibernate does and how => WorkFlow 8
- At Configuration + SessionFactory building + Session open/flush/close
- + Presentation of the main classes: => Architecture 8
- Mapping, Config, SessFactory, Session, Persister, Loader, Dialect, Query
- + Agile Patterns (links): UnitOfWork, IdentityMap ... => Patterns.NET 8
- + .NET techs used: Reflection, Nullables, Proxy, Attribute, XML & x.config
-
-+ Programming with NHibernate + FAQ & Tips Preface => Programming.NHibernate 8
- - Configuration (techs to set properties and adding mapping streams) => Configuration 8
- Cf. "NHibernate.Cfg.Environment" properties ...
- - <hibernate-mapping> elements and attributes => HibernateMapping 8
- + Basic Mapping (class, component, ID, property) => Mapping.Basic 8
- - Versioning + Optimistic/Pessimistic locking
- + Associations (<x-to-one>) + Bidirectional + Lazy loading => Mapping.Association 8
- + Collections: any, map, set, list, bag, array, <x-to-many> => Mapping.Collection 8
- + BLOB + value-typed collections + operations on them + Lazy loading
- - Inheritance mapping strategies (table-per-x) => Mapping.Inheritance 8
- + Query systems (HQL, ICriteria, IQuery): Aggregate funcs/Exprs, => HQL/Criteria/Query 8
- Formula in mapping, OrderBy, Join + Session.Enumerable/Scroll/Filter
- + Entities lifecycle (through CRUD ops), ID & Equals/GetHashCode tips => Entity.Lifecycle 8
- - Interacting using IInterceptor, IValidatable, ILyfeCycle
- + Session methods usage: => Session 8
- - Reconnect, Disconnect, Flush, IsDirty
- - Load, Get
- - Save, SaveOrUpdate, SaveOrUpdateCopy, Update + Delete
- - Evict, Lock, Refresh, Replicate
- - Exceptions explained (ExistingID, NoPersistersFor, StaleObjectState, ...) => Exceptions 8
- - Caching (1st & 2nd levels) + Session.Clear => Caching 8
- - SchemaExport => SchemaExport 9
- + Config & Mapping Schemas (reference) => Schemas.Reference 9
-
-+ Building Applications Preface => Building.Applications 8
- - Quick start (simple config.xml + mapping + sessionCreation & CRUD ops) => QuickStart 8
- + Architecture: => Application.Architecture 8
- - Layering your application (NHibernate in a n-tier Architecture)
- - About TDD, Continuous Integration, Refactoring ...
- - Applying Patterns: Gateway, DTO, Mapper ...
- - Implementing/Validating Business Rules (+ link to FIT)
- + Using .NET feats: Win/Web Services, Remoting, Serialization, Dataset, => Using.NET 8
- Enums, Generics, ...
- - Using Code Generation: MyGeneration & CodeSmith templates + others usages => CodeGeneration 8
- - On Performance, Memory usage, traps to avoid, common mistakes and caveats => Performance.Tips 9
- - Guidelines to debug NHibernate (how to quickly solve a problem) => Debugging 9
- + Creating Win/Web Applications (databinding & session management) => Application.Windows/Web 8
- - Report generation and Batch processing => Report.Batch 9
- + Supported Databases + related issues + Howto: Clustering, Paging ... => Databases 8
- - Native SQL support (named sql-query, running SQL queries ...)
-
-
-+ Contributions and Tools => ReadMe + Quick Start / Links - In /Contrib/ => Preface 5
- - NHibernate.Caches => NH.Caches 1
- - NHibernate.Mapping.Attributes => NH.Mapping.Attributes 0
- - NHibernate.Tool.hbm2net => NH.Tool.hbm2net 7
- - Nullables => Nullables 1
- - Iesi.Collections, HashCodeProvider, Castle.DynamicProxy => Libraries 7
- - Used/Useable tools (TODO: Add "WiX") => Tools 7
-
-+ LokateIt - In /Contrib/
- - Overview: What is LokateIt + features + goals (technical & academic) => LI.Preface 9
- - Link to Quick starts (in "Prog with NH" + in NHContrib) + LokateIt specs => LI.GettingStarted 9
- - Link to Agile & Patterns (for TDD) + Link to external tool NUnit
- - Rules and Domain Logic ([User] and [Rights]) => LI.Implementation.Base 9
- - The Windows User Interface (for [User] edition) => link to Create WinApps
- - Reference (Full Rules and Domain Logic) => link to NH feats used => LI.Implementation.Full 9
- - The Windows User Interface (Full) : Specificities of each Form
- - Reports - Multi-Database support - Server Application => LI.Additional.Features 9
- - Web Application => link to creating WebApps => LI.Implementation.Web 9
- - Conclusion (+ link to "Building Apps - Architecture") => LI.Conclusion 9
-
-
-+ More Samples and Getting Help
- - QuickStarts / Samples / Tutorials + links to internet ones ... => OnePageForEach... 8
- - More information and support => Support 5
-
-+ NHibernate Reference (Class Library)
-+ NHibernateContrib Reference (Class Library)
-
-- Appendix: Licenses (GNU LGPL & FDL) => License 0
-
---------------------------------------------------------------------------------
-
-ADD IF USEFUL:
-
- <!-- These extensions are required for table printing and other stuff
- <xsl:param name="use.extensions">0</xsl:param>
- <xsl:param name="tablecolumns.extension">0</xsl:param>
- <xsl:param name="callout.extensions">1</xsl:param>
- <xsl:param name="graphicsize.extension">0</xsl:param-->
-
-
-<!--###################################################
- Table Of Contents
- ###################################################
-
- <! Generate the TOCs for named components only
- <xsl:param name="generate.toc">
- book toc
- </xsl:param>
-
- <! Show only Sections up to level 3 in the TOCs
- <xsl:param name="toc.section.depth">3</xsl:param>
-
-<!###################################################
- Labels
- ###################################################
-
- <! Label Chapters and Sections (numbering)
- <xsl:param name="chapter.autolabel">1</xsl:param>
- <xsl:param name="section.autolabel" select="1"/>
- <xsl:param name="section.label.includes.component.label" select="1"/>
-
-<!###################################################
- Misc
- ###################################################
-
- <! Placement of titles
- <xsl:param name="formal.title.placement">
- figure after
- example before
- equation before
- table before
- procedure before
- </xsl:param> -->
-
---------------------------------------------------------------------------------
View
@@ -1,23 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Customization of the layout of NHibernate Documentation
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
-
- <xsl:import href="docbook-xsl/htmlhelp/htmlhelp.xsl"/>
-
- <xsl:include href="common.xsl"/>
-
-
- <!-- Customized HTML stylesheet !-->
- <xsl:param name="html.stylesheet" select="'style.css'" />
-
- <!-- TODO: Check this !-->
-
- <xsl:param name="suppress.navigation" select="0"/>
- <xsl:param name="htmlhelp.hhc.binary" select="0"/>
- <xsl:param name="htmlhelp.hhc.folders.instead.books" select="0"/>
-
- <xsl:param name="generate.index" select="1" />
-
-</xsl:stylesheet>
View
@@ -1,16 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Customization of the layout of NHibernate Documentation
--->
-<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
-
- <!-- Avoid numbered filenames (use "id") !-->
- <xsl:param name="use.id.as.filename" select="'1'"></xsl:param>
-
- <!-- Don't divide chapters in many files !-->
- <xsl:param name="chunk.section.depth" select="0"></xsl:param>
-
- <!-- Don't use graphics, use a simple number style !-->
- <xsl:param name="callout.graphics" select="'0'"></xsl:param>
-
-</xsl:stylesheet>
Oops, something went wrong.

0 comments on commit 51402ae

Please sign in to comment.