Audit and annotate all context-sensitive spots in ::Ordered

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Manual / DocMap.pod

diff --git a/lib/DBIx/Class/Manual/DocMap.pod b/lib/DBIx/Class/Manual/DocMap.pod
index 8d425bb..0b4966b 100644 (file)
--- a/lib/DBIx/Class/Manual/DocMap.pod
+++ b/lib/DBIx/Class/Manual/DocMap.pod
@@ -8,62 +8,67 @@ DBIx::Class::Manual::DocMap - What documentation do we have?
 
 =item L<DBIx::Class::Manual> - User's Manual overview.
 
-=item L<DBIx::Class::Manual::FAQ> - Frequently Asked Questions, gathered from IRC and the mailing list.
+=item L<DBIx::Class::Manual::QuickStart> - Up and running with DBIC in 10 minutes.
 
-=item L<DBIx::Class::Manual::Intro> - Introduction to setting up and using DBIx::Class.
+=item L<DBIx::Class::Manual::Intro> - More detailed introduction to setting up and using DBIx::Class.
 
-=item L<DBIx::Class::Manual::Example> - Full example Schema.
+=item L<DBIx::Class::Manual::SQLHackers> - How to use DBIx::Class if you know SQL (external, available on CPAN)
 
-=item L<DBIx::Class::Manual::Cookbook> - Various short recipes on how to do things.
+=item L<DBIx::Class::Manual::Joining> - Joining tables with DBIx::Class.
 
-=item L<DBIx::Class::Manual::Troubleshooting> - What to do if things go wrong (diagnostics of known error messages).
-
-=item L<DBIx::Class::Manual::Component> - How to write your own DBIx::Class components.
+=item L<DBIx::Class::Manual::Features> - A boatload of DBIx::Class features with links to respective documentation.
 
 =item L<DBIx::Class::Manual::Glossary> - What do all those terms mean?
 
-=back
+=item L<DBIx::Class::Manual::Cookbook> - Various short recipes on how to do things.
 
-=head1 Setting up
+=item L<DBIx::Class::Manual::FAQ> - Frequently Asked Questions, gathered from IRC and the mailing list.
 
-=over 4
+=item L<DBIx::Class::Manual::Troubleshooting> - What to do if things go wrong (diagnostics of known error messages).
 
-=item L<DBIx::Class::Schema> - Overall schemas, and connection container.
+=back
 
-=item L<DBIx::Class::ResultSource> - Source/Table definition functions.
+=head1 Some essential reference documentation
 
-=item L<DBIx::Class::Relationship> - Simple relationships.
+The first two list items are the most important.
 
-=item L<DBIx::Class::Relationship::Base> - Relationship details.
+=over 4
 
-=item L<DBIx::Class::PK::Auto> - Magically retrieve auto-incrementing fields.
+=item L<DBIx::Class::ResultSet/search> - Selecting and manipulating sets.
 
-=item L<DBIx::Class::Core> - Set of standard components to load.
+The DSL (mini-language) for query composition is only partially explained there,
+see L<SQL::Abstract/WHERE CLAUSES> for the complete details.
 
-=item L<DBIx::Class::Serialize::Storable> - ?
+=item L<C<$schema>::Result::C<$resultclass>|DBIx::Class::Manual::ResultClass>
+- Classes representing a single result (row) from a DB query.
 
-=item L<DBIx::Class::InflateColumn> - Making objects out of your columns.
+Such classes normally subclass L<DBIx::Class::Core>, the methods inherited
+from L<DBIx::Class::Row|DBIx::Class::Row/METHODS> and
+L<DBIx::Class::Relationship::Base|DBIx::Class::Relationship::Base/METHODS>
+are used most often.
 
-=item L<DBIx::Class::InflateColumn::DateTime> - Magically turn your datetime or timestamp columns into DateTime objects.
+=item L<DBIx::Class::ResultSetColumn> - Perform operations on a single column of a ResultSet.
 
-=item L<DBIx::Class::PK> - Dealing with primary keys.
+=item L<DBIx::Class::ResultSource> - Source/Table definition functions.
 
-=item L<DBIx::Class::ResultSourceProxy::Table> - Turns the resultsource into a table.
+=item L<DBIx::Class::Schema> - Overall sources, and connection container.
 
-=item L<DBIx::Class::AccessorGroup> - Accessor grouping.
+=item L<DBIx::Class::Relationship> - Simple relationship declarations.
 
-=back
+=item L<DBIx::Class::Relationship::Base> - Relationship declaration details.
 
-=head1 Retrieving and creating data
+=item L<DBIx::Class::InflateColumn> - Making objects out of your column values.
 
-=over 4
+=back
 
-=item L<DBIx::Class::ResultSet> - Selecting and manipulating sets.
+=head1 FURTHER QUESTIONS?
 
-=item L<DBIx::Class::ResultSetColumn> - Perform operations on entire columns of a ResultSet.
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
 
-=item L<DBIx::Class::Row> - Dealing with actual data.
+=head1 COPYRIGHT AND LICENSE
 
-=item L<DBIx::Class::Storage::DBI> - Storage using L<DBI> and L<SQL::Abstract>.
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
 
-=back