Commits

Mark Lavin  committed da6b6e1

Minor doc formatting changes.

  • Participants
  • Parent commits 5a2573e

Comments (0)

Files changed (3)

File docs/advanced.rst

 --------------------------------------
 
 The basic lookup is based on handling a search based on a single term string.
-If additional filtering is needed it can be inside the lookup `get_query` but
+If additional filtering is needed it can be inside the lookup ``get_query`` but
 you would need to define this when the lookup is defined. While this fits a fair
 number of use cases there are times when you need to define additional query
 parameters that won't be know until the either the form is bound or until selections
 _______________________________________
 
 As with the search term the additional parameters you define will be passed in
-`request.GET`. Since `get_query` gets the current request so you will have access to
+``request.GET``. Since ``get_query`` gets the current request so you will have access to
 them. Since they can be manipulated on the client side, these parameters should be
 treated like all user input. It should be properly validated and sanitized.
 
 
 The number of results are globally limited/paginated by the :ref:`SELECTABLE_MAX_LIMIT`
 but you can also lower this limit on the field or widget level. Each field and widget
-takes a `limit` argument in the `__init__` that will be passed back to the lookup
-through the `limit` query parameter. The result set will be automatically paginated
+takes a ``limit`` argument in the ``__init__`` that will be passed back to the lookup
+through the ``limit`` query parameter. The result set will be automatically paginated
 for you if you use either this parameter or the global setting.
 
 
 Adding Parameters on the Server Side
 _______________________________________
 
-Each of the widgets define `update_query_parameters` which takes a dictionary. The
-most common way to use this would be in the form `__init__`.
+Each of the widgets define ``update_query_parameters`` which takes a dictionary. The
+most common way to use this would be in the form ``__init__``.
 
     .. code-block:: python
 
 
 There are times where you want to filter the result set based other selections
 by the user such as a filtering cities by a previously selected state. In this
-case you will need to bind a `prepareQuery` to the field. This function should accept the query dictionary. 
+case you will need to bind a ``prepareQuery`` to the field. This function should accept the query dictionary. 
 You are free to make adjustments to  the query dictionary as needed.
 
     .. code-block:: html
 --------------------------------------
 
 You might want to help your users by submitting the form once they have selected a valid
-item. To do this you simply need to listen for the `autocompleteselect` event. This
-event is fired by the text input which has an index of 0. If you field is named `my_field`
-then input to watch would be `my_field_0` such as:
+item. To do this you simply need to listen for the ``autocompleteselect`` event. This
+event is fired by the text input which has an index of 0. If you field is named ``my_field``
+then input to watch would be ``my_field_0`` such as:
 
     .. code-block:: html
 

File docs/fields.rst

 
 Django-Selectable defines a number of fields for selecting either single or mutliple
 lookup items. Item in this context corresponds to the object return by the underlying
-lookup `get_item`. The single select select fields (:ref:`AutoCompleteSelectField` and
+lookup ``get_item``. The single select select fields (:ref:`AutoCompleteSelectField` and
 :ref:`AutoComboboxSelectField`) allow for the creation of new items. To use this feature the field's
-lookup class must define `create_item`. In the case of lookups extending from
+lookup class must define ``create_item``. In the case of lookups extending from
 :ref:`ModelLookup` newly created items have not yet been saved into the database and saving
 should be handled by the form. All fields take the lookup class as the first required
 argument.
 --------------------------------------
     
 Field tied to :ref:`AutoCompleteSelectWidget` to bind the selection to the form and  
-create new items, if allowed. The `allow_new` keyword argument (default: `False`)
+create new items, if allowed. The ``allow_new`` keyword argument (default: ``False``)
 which determines if the field allows new items. This field cleans to a single item.
 
     .. literalinclude:: ../example/core/forms.py
 --------------------------------------
 
 Field tied to :ref:`AutoComboboxSelectWidget` to bind the selection to the form and 
-create new items, if allowed. The `allow_new` keyword argument (default: `False`)
+create new items, if allowed. The ``allow_new`` keyword argument (default: ``False``)
 which determines if the field allows new items. This field cleans to a single item.
 
     .. literalinclude:: ../example/core/forms.py

File docs/widgets.rst

 --------------------------------------
 
 Basic widget for auto-completing text. The widget returns the item value as defined
-by the lookup `get_item_value`. If the `allow_new` keyword argument is passed as
+by the lookup ``get_item_value``. If the ``allow_new`` keyword argument is passed as
 true it will allow the user to type any text they wish.
 
 
 --------------------------------------
 
 Builds a list of selected items from auto-completion. This widget will return a list
-of item ids as defined by the lookup `get_item_id`. Using this widget with the
+of item ids as defined by the lookup ``get_item_id``. Using this widget with the
 :ref:`AutoCompleteSelectMultipleField` will clean the items to the item objects. This does
-not allow for creating new items. There is another optional keyword argument `postion`
+not allow for creating new items. There is another optional keyword argument ``postion``
 which can take four possible values: `bottom`, `bottom-inline`, `top` or `top-inline`.
 This determine the position of the deck list of currently selected items as well as
 whether this list is stacked or inline. The default is `bottom`.