Changeset 32

Show
Ignore:
Timestamp:
02/08/07 18:49:52 (6 years ago)
Author:
ged
Message:

- added download page
- merged about and index page. Changed the wording a bit to remove the

some repetition between the history and the description.

- added contact page, we might want to obfuscate the email addresses, though.
- commented easy_install reference in the tutorial (until easy_install actually

works)

Location:
elixir/trunk/docs
Files:
2 added
4 modified

Legend:

Unmodified
Added
Removed

  • elixir/trunk/docs/about.rst

    r30 r32  
    2424together. 
    2525 
    26 Around the same time, Gaëtan de Menten contacted both Jonathan and Daniel to 
    27 reveal that he had been working on his own layer as well.  A few weeks later, 
    28 all three agreed to work together to create a replacement for TurboEntity and 
    29 ActiveMapper using their collective experience and knowledge. 
     26Around the same time, `Gaëtan de Menten <http://openhex.com>`_ contacted both 
     27Jonathan and Daniel to reveal that he had been working on his own layer as  
     28well.  A few weeks later, all three agreed to work together to create a  
     29replacement for TurboEntity and ActiveMapper using their collective experience 
     30and knowledge. 
    3031 
    3132 

  • elixir/trunk/docs/index.rst

    r27 r32  
    33====== 
    44 
    5 ------------------ 
    6 Declarative Mapper 
    7 ------------------ 
     5Warning: this is a work in progress 
     6----------------------------------- 
    87 
    9 This is work in progress 
    10 ------------------------ 
     8----- 
     9About 
     10----- 
    1111 
    12 Elixir is a declarative layer on top of `SQLAlchemy 
    13 <http://www.sqlalchemy.org/>`_, which is intended to replace the `ActiveMapper 
    14 <http://cleverdevil.org/computing/35/>`_ SQLAlchemy extension, and the 
    15 `TurboEntity <http://turboentity.ematia.de>`_ project. Elixir is a fairly thin 
    16 wrapper around SQLAlchemy, which provides the ability to define model objects 
    17 following the Active Record design pattern, and using a DSL syntax similar to 
    18 that of the Ruby on Rails ActiveRecord system. 
     12Elixir is a declarative layer on top of `SQLAlchemy  
     13<http://www.sqlalchemy.org/>`_. It is a fairly thin wrapper, which provides  
     14the ability to define model objects following the Active Record design  
     15pattern, and using a DSL syntax similar to that of the Ruby on Rails  
     16ActiveRecord system. 
    1917 
    2018Elixir does not intend to replace SQLAlchemy's core features, but instead 
    … …  
    2220not need the full expressiveness of SQLAlchemy's manual mapper definitions. 
    2321 
     22------- 
     23History 
     24------- 
    2425 
     26In 2006, `Jonathan LaCour <http://cleverdevil.org>`_ discovered the fantastic 
     27`SQLAlchemy`_ project, and really liked its power and 
     28flexibility, but found that in many simple cases he would prefer a simpler and 
     29more attractive way to declare his model objects.  As a result, Jonathan spent 
     30a few hours on a weekend to create the `ActiveMapper  
     31<http://cleverdevil.org/computing/35/>`_ SQLAlchemy extension.  
     32For a weekend's worth of work, it wasn't half bad, and gained a little bit of  
     33traction in the wild.  But, over time, it became clear that ActiveMapper  
     34needed a lot of work to stabilize and become more useful. 
     35 
     36Later that year, `Daniel Haus <http://www.ematia.de>`_ released his own layer 
     37on top of SQLAlchemy, called `TurboEntity <http://turboentity.ematia.de>`_.  
     38TurboEntity solved some of the problems of ActiveMapper, and took a slightly 
     39different approach to the problem.  TurboEntity also began to gain some ground 
     40and it became clear to both Daniel and Jonathan that they needed to work 
     41together. 
     42 
     43Around the same time, `Gaëtan de Menten <http://openhex.com>`_ contacted both 
     44Jonathan and Daniel to reveal that he had been working on his own layer as  
     45well.  A few weeks later, all three agreed to work together to create a  
     46replacement for TurboEntity and ActiveMapper using their collective experience 
     47and knowledge. 
     48 
     49 
     50-------- 
     51The Name 
     52-------- 
     53 
     54The Oxford English Dictionary defines Elixir as: "a magical or medicinal potion, 
     55a preparation that was supposedly able to change metals into gold, sought by  
     56alchemists." 
     57 
     58 
     59---------- 
     60The Future 
     61---------- 
     62 
     63The eventual goal of the Elixir project is to become an official SQLAlchemy 
     64extension.  But, before we submit elixir for inclusion within SQLAlchemy, we 
     65want the opportunity to solicit feedback and contributions from users to make 
     66sure that we have ironed out any bugs, missing features, syntax changes, or 
     67documentation deficiencies. 
     68 
     69The primary things we would like to resolve before we make our first stable 
     70and official release are: 
     71 
     72- TODO 

  • elixir/trunk/docs/template/layout.html

    r26 r32  
    4040               title="Project Home / Index">${doc_title}</a> 
    4141        </li> 
     42        <li class="${destfile.startswith('download') and 'active' or None}"> 
     43            <a href="download.html" 
     44               title="Download">Download</a> 
     45        </li> 
    4246        <li class="${destfile.startswith('tutorial') and 'active' or None}"> 
    4347            <a href="tutorial.html" 
    … …  
    5357               Modules</a> 
    5458        </li> 
    55         <li class="${destfile.startswith('about ') and 'active' or None}last"> 
    56             <a href="${home_url}about.html"> 
    57                 About 
    58             </a> 
     59        <li class="${destfile.startswith('contact ') and 'active' or None}last"> 
     60            <a href="contact.html" 
     61               title="Contact">Contact</a> 
    5962        </li> 
    6063    </ul> 

  • elixir/trunk/docs/tutorial.rst

    r28 r32  
    33======== 
    44 
     5.. CHECKME: this is not rendered? 
     6 
    57--------- 
    68Diving in 
    … …  
    1012--------------- 
    1113         
    12 To show you how Elixir can help to increase your productivity, we will now 
    13 create a small and simple model. Before we start please make sure that you 
    14 already have the Elixir package installed. If not, do so by typing [#]_: 
    15  
    16 :: 
    17  
    18     easy_install Elixir 
    19  
    20 .. [#] If you don't even have "``easy_install``" yet, please visit the 
    21        `EasyInstall website 
    22        <http://peak.telecommunity.com/DevCenter/EasyInstall>`_ first and find 
    23        out how to use it (it's pretty easy, like the name promises). 
     14The first step is, of course, to install Elixir. For that purpose, please see  
     15the `download page <download.html>`_. 
     16 
     17.. To show you how Elixir can help to increase your productivity, we will now 
     18.. create a small and simple model. Before we start please make sure that you 
     19.. already have the Elixir package installed. If not, do so by typing [#]_: 
     20..  
     21.. :: 
     22..  
     23..     easy_install Elixir 
     24..  
     25.. .. [#] If you don't even have "``easy_install``" yet, please visit the 
     26..        `EasyInstall website 
     27..        <http://peak.telecommunity.com/DevCenter/EasyInstall>`_ first and find 
     28..        out how to use it (it's pretty easy, like the name promises). 
    2429 
    25302. A very simple model