summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2005-12-30 00:49:49 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2005-12-30 00:49:49 +0000
commit24bb21e8db0470443378057f2a1444de498c1e56 (patch)
tree4c375e53c86d654878ba31230bfdc40187eeaa6e /doc
parent232929e2ca8cb784bbc0c7d24ca819e08a6a72c1 (diff)
downloadsqlalchemy-24bb21e8db0470443378057f2a1444de498c1e56.tar.gz
some adjustments
Diffstat (limited to 'doc')
-rw-r--r--doc/build/components/formatting.myt2
-rw-r--r--doc/build/content/trailmap.myt22
-rw-r--r--doc/style.css4
3 files changed, 22 insertions, 6 deletions
diff --git a/doc/build/components/formatting.myt b/doc/build/components/formatting.myt
index 6405b2dbd..545db6821 100644
--- a/doc/build/components/formatting.myt
+++ b/doc/build/components/formatting.myt
@@ -114,6 +114,8 @@
if class_ is not None:
class_ = 'class="%s"' % class_
+ else:
+ class_ = ''
if href:
return '<a href="%s" %s>%s</a>' % (href, class_, text or href)
diff --git a/doc/build/content/trailmap.myt b/doc/build/content/trailmap.myt
index dcdc2a3e9..d672b0788 100644
--- a/doc/build/content/trailmap.myt
+++ b/doc/build/content/trailmap.myt
@@ -1,14 +1,23 @@
<%flags>inherit='document_base.myt'</%flags>
-<%attr>title='Roadmap'</%attr>
-<&|doclib.myt:item, name="trailmap", description="Trail Map" &>
-<p>SQLAlchemy includes several components, each of which are useful by themselves to give varying levels of assistance to a database-enabled application. Below is a Trail Map of the "knowledge dependencies" between these components indicating the order in which concepts may be learned.
+<%attr>title='Introduction'</%attr>
+<&|doclib.myt:item, name="intro", description="Introduction" &>
+<p>SQLAlchemy features a lot of tools and patterns to help in every area of writing applications that talk to relational databases. To achieve this, it has a lot of areas of functionality which work together to provide a cohesive package. Ultimately, just a little bit of familiarity with each concept is all thats needed to get off the ground.</p>
+
+<p>That said, here's two quick links that summarize the two most prominent features of SQLAlchemy:
+<ul>
+ <li><&formatting.myt:link, path="datamapping", class_="trailbold"&> - a synopsis of how to map objects to database tables (Object Relational Mapping)</li>
+ <li><&formatting.myt:link, path="sql", class_="trailbold"&> - SQLAlchemy's own domain-oriented approach to constructing and executing SQL statements.</li>
+</ul>
</p>
+<&|doclib.myt:item, name="trailmap", description="Trail Map" &>
+<p>For a comprehensive tour through all of SQLAlchemy's components, below is a "Trail Map" of the knowledge dependencies between these components indicating the order in which concepts may be learned. Concepts marked in bold indicate features that are useful on their own.
+</p>
<pre>
Start
|
|
- |--- <&formatting.myt:link, path="pooling" &>
+ |--- <&formatting.myt:link, class_="trailbold", path="pooling" &>
| |
| |
| |------ <&formatting.myt:link, path="pooling_configuration" &>
@@ -26,10 +35,10 @@ Start
|---- <&formatting.myt:link, path="metadata_creating" &>
|
|
- |---- <&formatting.myt:link, path="sql" &>
+ |---- <&formatting.myt:link, path="sql", class_="trailbold" &>
| |
| |
- +---- <&formatting.myt:link, path="datamapping"&> |
+ +---- <&formatting.myt:link, path="datamapping", class_="trailbold"&> |
| | |
| | |
| <&formatting.myt:link, path="unitofwork"&> |
@@ -40,3 +49,4 @@ Start
+----- <&formatting.myt:link, path="types"&>
</pre>
</&>
+</&>
diff --git a/doc/style.css b/doc/style.css
index bc4d8a31a..aa339e249 100644
--- a/doc/style.css
+++ b/doc/style.css
@@ -29,6 +29,10 @@ a:hover {color:#700000;}
margin: 5px;
}
+.trailbold {
+ font-weight:bold;
+}
+
.light {
background-color: #EFEFEF;
}