Commits

Mark Lavin committed aab8161

Adding internal doc references.

Comments (0)

Files changed (3)

 
 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 (`AutoCompleteSelectField` and
-`AutoComboboxSelectField`) allow for the creation of new items. To use this feature the field's
+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
-`ModelLookup` newly created items have not yet been saved into the database and saving
+: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.
 
 
+.. _AutoCompleteSelectField:
+
 AutoCompleteSelectField
 --------------------------------------
     
-Field tied to `AutoCompleteSelectWidget` to bind the selection to the form and  
+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`)
 which determines if the field allows new items. This field cleans to a single item.
 
 
+.. _AutoComboboxSelectField:
+
 AutoComboboxSelectField
 --------------------------------------
 
-Field tied to `AutoComboboxSelectWidget` to bind the selection to the form and 
+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`)
 which determines if the field allows new items. This field cleans to a single item.
 
 
+.. _AutoCompleteSelectMultipleField:
+
 AutoCompleteSelectMultipleField
 --------------------------------------
 
-Field tied to `AutoCompleteSelectMultipleWidget` to bind the selection to the form.
-This field cleans to a list of items. `AutoCompleteSelectMultipleField` does not
+Field tied to :ref:`AutoCompleteSelectMultipleWidget` to bind the selection to the form.
+This field cleans to a list of items. :ref:`AutoCompleteSelectMultipleField` does not
 allow for the creation of new items.
 
 
+.. _AutoComboboxSelectMultipleField:
+
 AutoComboboxSelectMultipleField
 --------------------------------------
 
-Field tied to `AutoComboboxSelectMultipleWidget` to bind the selection to the form.
-This field cleans to a list of items. `AutoComboboxSelectMultipleField` does not 
+Field tied to :ref:`AutoComboboxSelectMultipleWidget` to bind the selection to the form.
+This field cleans to a list of items. :ref:`AutoComboboxSelectMultipleField` does not 
 allow for the creation of new items.
     :return: A dictionary of information for this item to be sent back to the client.
 
 
+.. _ModelLookup:
+
 Lookups Based on Models
 --------------------------------------
 
 lookup class as the first required argument.
 
 
+.. _AutoCompleteWidget:
+
 AutoCompleteWidget
 --------------------------------------
 
 true it will allow the user to type any text they wish.
 
 
+.. _AutoComboboxWidget:
+
 AutoComboboxWidget
 --------------------------------------
 
-Similar to `AutoCompleteWidget` but has a button to reveal all options.
+Similar to :ref:`AutoCompleteWidget` but has a button to reveal all options.
 
 
+.. _AutoCompleteSelectWidget:
+
 AutoCompleteSelectWidget
 --------------------------------------
 
 Widget for selecting a value/id based on input text. Optionally allows selecting new items to be created.
-This widget should be used in conjunction with the `AutoCompleteSelectField` as it will
+This widget should be used in conjunction with the :ref:`AutoCompleteSelectField` as it will
 return both the text entered by the user and the id (if an item was selected/matched).
 
 
+.. _AutoComboboxSelectWidget:
+
 AutoComboboxSelectWidget
 --------------------------------------
 
-Similar to `AutoCompleteSelectWidget` but has a button to reveal all options.
+Similar to :ref:`AutoCompleteSelectWidget` but has a button to reveal all options.
 
 
+.. _AutoCompleteSelectMultipleWidget:
+
 AutoCompleteSelectMultipleWidget
 --------------------------------------
 
 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
-`AutoCompleteSelectMultipleField` will clean the items to the item objects. This does
+: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`
 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`.
 
 
+.. _AutoComboboxSelectMultipleWidget:
+
 AutoComboboxSelectMultipleWidget
 --------------------------------------
 
-Same as `AutoCompleteSelectMultipleWidget` but with a combobox.
+Same as :ref:`AutoCompleteSelectMultipleWidget` but with a combobox.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.