Commits

Simone Marzola  committed f40ca67 Draft

documentation update

  • Participants
  • Parent commits fd117ff

Comments (0)

Files changed (7)

File docs/content.rst

 Standard Slices
 ----------------------
 
-HTML
+Html
 """"
 
 HTML slice contains only a rich badass WYSIWYG editor, where you can freely insert any kind of content. The image insert uses
 :ref:`ACRcms's assets manager <asset-manager>` to store and retrieve your contents. Please refer to the `CKEditor user guide <http://docs.cksource.com/CKEditor_3.x/Users_Guide>`_
 for the complete how to.
 
-GENSHI
+Genshi
 """"""
 
 GENSHI slice permits you to add `Genshi Template Directives <http://genshi.edgewall.org/wiki/Documentation/0.6.x/xml-templates.html#template-directives>`_, such
 
 Cool, isn't it?
 
-MENU
+Menu
 """"
 
 Autogenerated menu, you only have to select if you want an horizontal or a vertical menu, and the root of the menu.
 
-LINK
+Link
 """"
 
 An external html link.
 
-AJAX
+Ajax
 """"
 
 Ajax loaded content.
 
-RSS
+Rss
 """
 
 rss aggregator, add the rss feed uri and eventually a tag filter and it magically works.
 
-COMMENTS THREAD
+Comments thread
 """""""""""""""
 
 Deprecated, left only for retrocompatibility. Please use :ref:`disqus-thread`.
 
-TWITTER RSS
+Twitter rss
 """""""""""
 
 What the hell, Twitter supports only Atom feeds :)
 
-FILE
+File
 """"
 
 Insert a downloadable file using the asset manager. Choose an asset using the assets box, or upload a new one. For further reference, please
 read :ref:`ACRcms's assets manager <asset-manager>`.
 
 
-FORM
+Form
 """"
 
 An automatic submission form creator. The syntax is pretty simple, ``fieldname=fieldtype``, one for row. Available field types:
 .. image:: images/form.png
 
 
-
-IMAGE
+Image
 """""
 
 Insert an image using the asset manager. Choose an image using the assets box, or upload a new one. For further reference, please
 You can also set the image size, an external link and the image title.
 
 
-SEARCH
+Search
 """"""
 
 Inserts a simple search bar. It's possible to restrict the search on selected :ref:`tags <tags>`.
 
-VIDEO
+Video
 """""
 
 Insert a video using the asset manager. Choose a video file using the assets box, or upload a new one. For further reference, please
 
 The video will be automatically converted to a web suitable format.
 
-SCRIPT
+Script
 """"""
 
 With this slice type you can insert custom JavaScript code in your page to customize your page behavior.
 
 
-TAG CLOUD
+Tag cloud
 """""""""
 
 Tag cloud that aggregates the tags of your blog posts.
 
-BLOGPOST
+Blogpost
 """"""""
 
 Deprecated, left only for retrocompatibility. Please use :ref:`disqus-thread`.
 
 
-SLICEGROUP ADMIN
+Slicegroup Admin
 """"""""""""""""
 
 Adds a bar with two links to add or edit :ref:`slice group <slice-group>` contents.
 
 .. _disqus-thread:
 
-DISQUS THREAD
+Disqus thread
 """""""""""""
 
-MAP
+Adds a discussion thread to your page using the disqus comment system. You must configure the plugin with your disqus User ID before
+using it. Refer to :ref:`Disqus Config <config-disqus>` for more details. 
+
+Map
 """
 
-BLOG ARTICLES
+Google Maps Plugin, you have only to fill the address field and configure the zoom level and the map size.
+
+Blog Articles
 """""""""""""
 
-PHOTO ALBUM
+The blog articles slice aggregates all the post of a blog category. You must have configured at least one blog category, refer to
+:ref:`Blog Config <config-smallpress>`.
+
+Photo Album
 """""""""""
 
+A complete photogallery plugin, with categories and thumbnails generator. The use is simple, just add the slice, then select the album and it's done.
+To add and manage albums refer to :ref:`Photo Config <config-photos>`.

File docs/howto.rst

+Let's start using ACRCms
+========================
+
+Introduction
+------------
+
+Creating a website with ACRCms is easy and painless. In this tutorial, you will learn how to:
+
+* :ref:`Log in <tutorial-login>`
+* :ref:`Insert your first content <tutorial-content>`
+* :ref:`Edit a content <tutorial-edit>`
+* :ref:`Add a cool image <tutorial-image>`
+* :ref:`Insert a community driven comments thread <tutorial-comments>`
+* :ref:`Create a new page <tutorial-page>`
+* :ref:`Add a blog section <tutorial-blog>`
+* :ref:`Create an image gallery <tutorial-gallery>`
+* :ref:`Add a fully functional search bar <tutorial-search>`
+* :ref:``
+
+.. _tutorial-login:
+
+Log In
+------
+
+Visit the url ``yourwebpage/login``, a login mask will appear. After the installation the default credentials are:
+
+User: manager
+
+Password: managepass 
+
+When you are logged in, at top of the page appears the topbar and over every content appears an edit bar. If the edit bars
+bother you, you can disable them clicking on TOGGLE EDIT BARS.
+
+.. _tutorial-content:
+
+Insert your first content
+-------------------------
+
+The easiest way to add a custom content to the page is the html slice. Click on **ADD SLICE** in the top bar, and then on **HTML**.
+
+The html edit box will appear. For now the only field that interests us is the rick WYSIWYG editor, let's write something interesting:
+
+.. image:: images/html_editor.png
+
+save it and take a look to the web page. The content is there. Simple, isn't it?
+
+.. _tutorial-edit:
+
+Edit a content
+--------------
+
+Editing a content is as simple as inserting a new one, just click the edit button in the edit bar over the content you want to modify.
+As you can see, is now appeared the versions box. What the hell is that? Well, it's one of the most powerful features of ACRCms: every time 
+you edit a content, the previous version remains stored in the database and you can roll it back whenever you want. You have to admit that 
+this piece of software rocks :). Ok, so, click on edit in the versions and translations box, edit a content and then save it. And, then try to
+click on revert on a previous version. It's magic™.
+
+
+.. _tutorial-image:
+
+Add a cool image
+-------------------
+
+Add an image slice (**ADD SLICE -> IMAGE**). The box that appears is the ACRCms asset chooser.
+
+.. image:: images/asset_chooser.png
+
+the usage is pretty simple, just select an already uploaded asset from the assets browser, or upload a new image, return to the asset chooser and select it.
+
+Fill the title field, insert a web link if want to open a new web page on image click, insert a specific dimension (*auto* will preserve the actual image size) 
+and provide a description (facoltative).
+
+Save the slice, and your image is displayed on the bottom of the page.
+
+
+.. _tutorial-comments:
+
+Insert a community driven comments thread
+-----------------------------------------
+
+Ready to face the community? So you can add a comment thread, provided by the disqus plugin. A preliminary step is required only the first time 
+you add a comment thread: register yourself to disqus.com, 
+from the disqus dashboard, add a website, fill the url of your ACRCms website and add the site name. Return back to ACRCms, click on ADMIN in the topbar, and
+ then click on Disqus icon (general setting panel). Insert the website name in the User ID field and click change.
+
+.. image:: images/disqus_admin.png
+
+Now return back to your site page, click on **ADD SLICE -> DISQUS THREAD**, don't change any field and click save. Ok you have your comments thread.
+
+.. _tutorial-page:
+
+Create a new page
+-----------------
+
+When your site has grown up, you need a new page to accomodate your contents. It's a trivial task: click on **ADMIN -> CREATE PAGE**.
+
+On the page create box, you have to select the page parent. Just remember a couple of things:
+
+1. if you select ``-----------`` as parent, the page will be on the root of the website
+2. if you select ``Default page for global layout`` as parent, the page will be hidden
+3. *Any other choice* as parent, the page will be a child of the page selected
+
+For this tutorial, we are going to select ``------------``, insert test as title and url and save. You will be redirected to the newly created page
+and a new menu entry for that page is automagically added on the top menu.
+
+
+.. _tutorial-blog:
+
+Add a blog section
+------------------
+
+
+.. _tutorial-gallery:
+
+Create an image gallery
+-----------------------
+
+
+.. _tutorial-search:
+
+Add a fully functional search bar
+---------------------------------
+
+
+
+
+
+
+
+
+
+
+

File docs/images/asset_chooser.png

Added
New image

File docs/images/disqus_admin.png

Added
New image

File docs/images/html_editor.png

Added
New image

File docs/index.rst

 and embeddable in any web site using the Turbogears framework.
 
 
-Users HOW TO
--------------
+Getting Started
+---------------
+
+.. toctree::
+   :maxdepth: 2
+
+   howto
+
+
+User Reference
+---------------
 
 .. toctree::
    :maxdepth: 3
    
-   pages
    content
 
-
-Developers HOW TO
+Developer Reference
 -------------------
 
 .. toctree::
    :maxdepth: 2
    
-   install
-
 
 Indices and tables
 ==================

File docs/pages.rst

Empty file added.