doc/index.rst
changeset 10491 c67bcee93248
child 10492 68c13e0c0fc5
equal deleted inserted replaced
10490:76ab3c71aff2 10491:c67bcee93248
       
     1 =====================================================
       
     2 |cubicweb| - The Semantic Web is a construction game!
       
     3 =====================================================
       
     4 
       
     5 |cubicweb| is a semantic web application framework, licensed under the LGPL,
       
     6 that empowers developers to efficiently build web applications by reusing
       
     7 components (called `cubes`) and following the well known object-oriented design
       
     8 principles.
       
     9 
       
    10 Main Features
       
    11 ~~~~~~~~~~~~~
       
    12 
       
    13 * an engine driven by the explicit :ref:`data model
       
    14   <TutosBaseCustomizingTheApplicationDataModel>` of the application,
       
    15 
       
    16 * a query language named :ref:`RQL <RQL>` similar to W3C's SPARQL,
       
    17 
       
    18 * a :ref:`selection+view <TutosBaseCustomizingTheApplicationCustomViews>`
       
    19   mechanism for semi-automatic XHTML/XML/JSON/text generation,
       
    20 
       
    21 * a library of reusable :ref:`components <Cube>` (data model and views) that
       
    22   fulfill common needs,
       
    23 
       
    24 * the power and flexibility of the Python_ programming language,
       
    25 
       
    26 * the reliability of SQL databases, LDAP directories, Subversion and Mercurial
       
    27   for storage backends.
       
    28 
       
    29 Built since 2000 from an R&D effort still continued, supporting 100,000s of
       
    30 daily visits at some production sites, |cubicweb| is a proven end to end solution
       
    31 for semantic web application development that promotes quality, reusability and
       
    32 efficiency.
       
    33 
       
    34 QuickStart
       
    35 ~~~~~~~~~~
       
    36 
       
    37 The impatient developer will move right away to :ref:`SetUpEnv` then to :ref:`ConfigEnv`.
       
    38 
       
    39 Social
       
    40 ~~~~~~
       
    41 
       
    42 *   Chat on the `jabber forum`_
       
    43 *   Discuss on the `mailing-list`_
       
    44 *   Discover on the `blog`_
       
    45 *   Contribute on the forge_
       
    46 
       
    47 
       
    48 .. _Logilab: http://www.logilab.fr/
       
    49 .. _forge: http://www.cubicweb.org/project/
       
    50 .. _Python: http://www.python.org/
       
    51 .. _`jabber forum`: http://www.logilab.org/blogentry/6718
       
    52 .. _`mailing-list`: http://lists.cubicweb.org/mailman/listinfo/cubicweb
       
    53 .. _blog: http://www.cubicweb.org/blog/1238
       
    54 
       
    55 
       
    56 Narrative Documentation
       
    57 ~~~~~~~~~~~~~~~~~~~~~~~
       
    58 
       
    59 A.k.a. "The Book"
       
    60 
       
    61 .. toctree::
       
    62    :maxdepth: 2
       
    63 
       
    64    book/intro/index
       
    65 
       
    66 .. toctree::
       
    67    :maxdepth: 3
       
    68 
       
    69    book/devrepo/index
       
    70    book/devweb/index
       
    71 
       
    72 .. toctree::
       
    73    :maxdepth: 2
       
    74 
       
    75    book/admin/index
       
    76    book/additionnal_services/index
       
    77    book/annexes/index
       
    78 
       
    79 Tutorial
       
    80 ~~~~~~~~
       
    81 
       
    82 We present two tutorials of different levels. The blog building
       
    83 tutorial introduces one smoothly to the basic concepts.
       
    84 
       
    85 Then there is a photo gallery construction tutorial which highlights
       
    86 more advanced concepts such as unit tests, security settings,
       
    87 migration scripts.
       
    88 
       
    89 .. toctree::
       
    90    :maxdepth: 1
       
    91    :numbered:
       
    92 
       
    93    tutorials/base/index
       
    94    tutorials/advanced/index
       
    95    tutorials/tools/windmill.rst
       
    96    tutorials/textreports/index
       
    97 
       
    98 
       
    99 Reference documentation
       
   100 ~~~~~~~~~~~~~~~~~~~~~~~
       
   101 
       
   102 .. toctree::
       
   103     :maxdepth: 1
       
   104 
       
   105     js_api/index
       
   106 
       
   107 Indexes
       
   108 ~~~~~~~
       
   109 
       
   110 * the :ref:`genindex`,
       
   111 * the :ref:`modindex`,