.. _overview:


********
Overview
********

.. _DMCM:

DMCM
====

Django Markdown Content Manager
is a web application built using the `Django <http://www.djangoproject.org/>`_ framework.
It enables users to manage web page content written using the 
`Markdown <http://daringfireball.net/projects/markdown/syntax>`_ syntax.

The web pages have a common structure which is defined in a Django template. Within that
structure, the main body of the page content is written in Markdown.

The web pages are published by being written to the server as *.html* files.

This approach combines the efficiency of serving static html web pages to visitors 
with the ease of using a markup language to enter content.

The Content Manager is a Django Application while the live site consists of static html. 

Design inspired by:

* `TiddlyWiki <http://tiddlywiki.com>`_ offline Wiki.
* `Hyde <http://ringce.com/hyde>`_ static site generator.
* `Sphinx <http://sphinx.pocoo.org>`_ Python documentation generator.

.. index:: Design Overview (Overview)

.. _design_diagram:

Design Overview
---------------

.. _image-design:
.. image:: _static/design.png
    :alt: DMCM Design

.. index:: ahernp.com homepage (Overview)

Example
-------

The homepage of the `ahernp.com <http://ahernp.com>`_ site:

.. _image-home-page:
.. image:: _static/ahernp_homepage.png
    :alt: ahernp.com home page

Was built from this Django Page Template:

.. literalinclude:: _static/ahernp_page_template.txt
   :language: guess
   :linenos:

And the following Markdown text:

.. literalinclude:: _static/ahernp_homepage_source.txt
   :language: guess
   :linenos:

.. index:: Javascript (Overview)

.. _javascript:

Javascript
==========

The `ahernp.com <http://ahernp.com>`_ is designed to look good
(or at least be usable) even when rendered by a browser where Javascript
is not enabled.

The only Javascript used by DMCM or on the published site:

*  `dataTables <http://www.datatables.net>`_ 
   allows filtering and sorting of all HTML tables::

    $(document).ready(function() {
        /* No pagination; No initial sort. */
        $("table").dataTable({"bPaginate": false, "aaSorting": []});
    });



*  `lightbox <http://jquery.com/plugins/project/jquerylightbox_bal>`_
   makes all links to *.jpg* files into slideshows::

    $(document).ready(function(){
        /* Turn all links to .jpg files into lightboxes. */
        $("a[href$='.jpg']").lightbox();
    });

*  `disqus <http://disqus.com>`_ manages comments on Blog Entry Pages. 
   (see :ref:`Blog Page <blog_page_structure>`)

.. index:: Release Notes (Overview)

.. _release_notes:

Release Notes
=============

Version 0.2
-----------

Released on 10 June 2010.

*  Added Blog.
*  Added *Edit* links to published pages and *Site* link to DMCM navigation menu.
*  Added `django-revision` package to keep history of site contents.
*  Upgraded from Django 1.1.1 to 1.2.1.

Version 0.1
-----------

Released on 2 June 2010.

*  Initial Proof of concept release.


.. index:: To Do List (Overview)

.. _todo_list:

To Do List
==========

.. todolist::