From d5a97c0c5991abf6eb4d3ba54414d8d39d43ac33 Mon Sep 17 00:00:00 2001 From: Benjamin Eberlei Date: Fri, 27 Jan 2012 21:36:36 +0100 Subject: [PATCH] Add fancy new index page, moving toc to toc.rst --- en/index.rst | 155 ++++++++++++++++++++++++++++++++------------------- en/toc.rst | 73 ++++++++++++++++++++++++ 2 files changed, 172 insertions(+), 56 deletions(-) create mode 100644 en/toc.rst diff --git a/en/index.rst b/en/index.rst index 36697b429..8f0124466 100644 --- a/en/index.rst +++ b/en/index.rst @@ -1,72 +1,115 @@ Welcome to Doctrine 2 ORM's documentation! ========================================== -Reference Guide +The Doctrine documentation is comprised of tutorials, a reference section and +cookbook articles that explain different parts of the Object Relational mapper. + +Doctrine DBAL and Doctrine Common both have their own documentation. + +Getting Help +------------ + +If this documentation is not helping to answer questions you have about +Doctrine ORM don't panic. You can get help from different sources: + +- There is a :doc:`FAQ ` with answers to frequent questions. +- The `Doctrine Mailing List `_ +- Internet Relay Chat (IRC) in `#doctrine on Freenode `_ +- Report a bug on `JIRA `_. +- On `Twitter `_ with ``#doctrine2`` +- On `StackOverflow `_ + +If you need more structure over the different topics you can browse the :doc:`table +of contents `. + +Getting Started --------------- -.. toctree:: - :maxdepth: 1 - :numbered: +* **Tutorial**: + :doc:`Getting Started ` - reference/introduction - reference/architecture - reference/configuration - reference/faq - reference/basic-mapping - reference/association-mapping - reference/inheritance-mapping - reference/working-with-objects - reference/working-with-associations - reference/transactions-and-concurrency - reference/events - reference/batch-processing - reference/dql-doctrine-query-language - reference/query-builder - reference/native-sql - reference/change-tracking-policies - reference/partial-objects - reference/xml-mapping - reference/yaml-mapping - reference/annotations-reference - reference/php-mapping - reference/caching - reference/improving-performance - reference/tools - reference/metadata-drivers - reference/best-practices - reference/limitations-and-known-issues +* **Reference**: + :doc:`Introduction ` | + :doc:`Architecture ` | + :doc:`Configuration ` | + :doc:`Tools ` | + :doc:`Limitations and knowns issues ` -Tutorials ---------- +Mapping Objects onto a Database +------------------------------- -.. toctree:: - :maxdepth: 1 +* **Basic Reference**: + :doc:`Mapping Objects and Fields ` | + :doc:`Mapping Associations ` | + :doc:`Inheritance Mapping ` - tutorials/getting-started-xml-edition - tutorials/working-with-indexed-associations - tutorials/extra-lazy-associations - tutorials/composite-primary-keys +* **Mapping Driver References**: + :doc:`XML ` | + :doc:`YAML ` | + :doc:`Docblock Annotations ` | + :doc:`PHP Mapping ` | + :doc:`Metadata Drivers ` +Working with Objects +-------------------- + +* **Basic Reference**: + :doc:`Working with Objects ` | + :doc:`Working with Assocations ` | + :doc:`Events ` + +* **Querying Objects**: + :doc:`DQL - Doctrine Query Language ` | + :doc:`QueryBuilder ` | + :doc:`Native SQL Queries ` + +* **Tutorials**: + :doc:`Working with indexed associations ` | + :doc:`Extra Lazy Assocations ` | + :doc:`Composite Primary Keys ` + +Advanced Topics +--------------- + +* **Database Integration**: + :doc:`Transactions and Concurrency ` + +* **Performance**: + :doc:`Improving Performance ` | + :doc:`Caching ` | + :doc:`Partial Objects ` | + :doc:`Change Tracking Policies ` + +* **Best Practices**: + :doc:`Best Practices ` Cookbook -------- -.. toctree:: - :maxdepth: 1 +* **Patterns**: + :doc:`Aggregate Fields ` | + :doc:`Decorator Pattern ` | + :doc:`Strategy Pattern ` | - cookbook/aggregate-fields - cookbook/decorator-pattern - cookbook/dql-custom-walkers - cookbook/dql-user-defined-functions - cookbook/implementing-arrayaccess-for-domain-objects - cookbook/implementing-the-notify-changetracking-policy - cookbook/implementing-wakeup-or-clone - cookbook/integrating-with-codeigniter - cookbook/sql-table-prefixes - cookbook/strategy-cookbook-introduction - cookbook/validation-of-entities - cookbook/working-with-datetime - cookbook/mysql-enums - cookbook/advanced-field-value-conversion-using-custom-mapping-types - cookbook/entities-in-session +* **DQL Extension Points**: + :doc:`DQL Custom Walkers ` | + :doc:`DQL User-Defined-Functions ` + +* **Implementation**: + :doc:`Array Access ` | + :doc:`Notify ChangeTracking Example ` | + :doc:`Using Wakeup Or Clone ` | + :doc:`Working with DateTime ` | + :doc:`Validation ` | + :doc:`Entities in the Session ` + +* **Integration into Frameworks/Libraries** + :doc:`CodeIgniter ` + +* **Hidden Gems** + :doc:`Prefixing Table Name ` + +* **Custom Datatypes** + :doc:`MySQL Enums ` + :doc:`Advanced Field Value Conversion ` diff --git a/en/toc.rst b/en/toc.rst new file mode 100644 index 000000000..2c078eabd --- /dev/null +++ b/en/toc.rst @@ -0,0 +1,73 @@ +Welcome to Doctrine 2 ORM's documentation! +========================================== + +Tutorials +--------- + +.. toctree:: + :maxdepth: 1 + + tutorials/getting-started-xml-edition + tutorials/working-with-indexed-associations + tutorials/extra-lazy-associations + tutorials/composite-primary-keys + +Reference Guide +--------------- + +.. toctree:: + :maxdepth: 1 + :numbered: + + reference/introduction + reference/architecture + reference/configuration + reference/faq + reference/basic-mapping + reference/association-mapping + reference/inheritance-mapping + reference/working-with-objects + reference/working-with-associations + reference/transactions-and-concurrency + reference/events + reference/batch-processing + reference/dql-doctrine-query-language + reference/query-builder + reference/native-sql + reference/change-tracking-policies + reference/partial-objects + reference/xml-mapping + reference/yaml-mapping + reference/annotations-reference + reference/php-mapping + reference/caching + reference/improving-performance + reference/tools + reference/metadata-drivers + reference/best-practices + reference/limitations-and-known-issues + + + +Cookbook +-------- + +.. toctree:: + :maxdepth: 1 + + cookbook/aggregate-fields + cookbook/decorator-pattern + cookbook/dql-custom-walkers + cookbook/dql-user-defined-functions + cookbook/implementing-arrayaccess-for-domain-objects + cookbook/implementing-the-notify-changetracking-policy + cookbook/implementing-wakeup-or-clone + cookbook/integrating-with-codeigniter + cookbook/sql-table-prefixes + cookbook/strategy-cookbook-introduction + cookbook/validation-of-entities + cookbook/working-with-datetime + cookbook/mysql-enums + cookbook/advanced-field-value-conversion-using-custom-mapping-types + cookbook/entities-in-session +