Changeset 2145 in main for trunk/docs


Ignore:
Timestamp:
03/11/13 16:04:00 (6 years ago)
Author:
pcosquer
Message:

docs: richtext: markdown syntax

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/en/devel/richtext.rst

    r2144 r2145  
    115115================== 
    116116 
    117 Python Markdown 
     117OpenPLM ships with a `Markdown`_ syntax. 
    118118 
    119 Extensions 
     119It can be enabled with the following settings:: 
    120120 
     121    RICHTEXT_FILTER = 'openPLM.plmapp.filters.markdown_filter' 
     122    RICHTEXT_WIDGET_CLASS = 'openPLM.plmapp.widgets.MarkdownWidget' 
     123 
     124The filter is built with `Python Markdown`_ with the ``safe_mode`` option activated 
     125and the following extensions: 
     126 
     127    * ``abbr``, 
     128    * ``tables``, 
     129    * ``def_list``, 
     130    * ``smart_strong``,  
     131    * ``toc``. 
     132 
     133More custom extensions are enabled, they added the following syntaxes: 
     134 
     135.. list-table:: 
     136 
     137    * - :samp:`[{type}/{reference}/{revision}]` 
     138      - link to a PLMObject 
     139    * - :samp:`<<` 
     140      - link to the previous revision of the current object 
     141    * - :samp:`>>` 
     142      - link to the next revision of the current object 
     143    * - :samp:`@{username}` 
     144      - link to a user page 
     145    * - :samp:`group:{name}` 
     146      - link to a group 
     147 
     148 
     149The javascript editor is based on `MarkEdit`_, it renders the preview 
     150with :func:`.ajax_richtext_preview`. 
     151 
     152.. _Python Markdown: http://pythonhosted.org/Markdown/index.html 
     153 
     154.. _Markdown: http://daringfireball.net/projects/markdown/ 
     155 
     156.. _MarkEdit: http://tstone.github.com/jquery-markedit/ 
    121157 
    122158 
Note: See TracChangeset for help on using the changeset viewer.