Commits

Anonymous committed 10ba498

bugfix in readme

  • Participants
  • Parent commits cd9eadc

Comments (0)

Files changed (1)

 Indexing
 --------
 
- Hence you use the out of the box indexer, I will explain now how to fed it. Maybe you want to do:
+Hence you use the out of the box indexer, I will explain now how to fed it. Maybe you want to do:
  
- * Easily fead all instances of a model.
- * Exclude some fields.
- * Exclude some instances.
+* Easily fead all instances of a model.
+* Exclude some fields.
+* Exclude some instances.
   
- In your root-urlconf, activate the indexer::
+In your root-urlconf, activate the indexer::
   
   	from simplesearch import index
   	index.autodiscover()
   
- In the file you've specified in the INDEXER_CONF variable in your *settings.py* (the default is *indexer*), you have to initialize the index::
+In the file you've specified in the INDEXER_CONF variable in your *settings.py* (the default is *indexer*), you have to initialize the index::
  
  	from simplesearch import index
  
- The easiest way to build the index is to add the whole project::
+The easiest way to build the index is to add the whole project::
  
  	index.index_project()
  	
- What happens now? All models from all installed apps are examined, so that all indexable fields are used for the index. There's no single field or model-instance which is excluded of the search results. 
+What happens now? All models from all installed apps are examined, so that all indexable fields are used for the index. There's no single field or model-instance which is excluded of the search results. 
  
- For example TextFields are indexable, BooleanFields are not.
+For example TextFields are indexable, BooleanFields are not.
  
- The more fine granular step is do index a whole app::
+The more fine granular step is do index a whole app::
  
  	index.index_app('django.contrib.comments') 
  	
- or just::
+or just::
  
  	index.index_app('comments')
  	
- In both cases, all models are indexed. Even more fine granular is to index a very model of an app. Therefore just write::
+In both cases, all models are indexed. Even more fine granular is to index a very model of an app. Therefore just write::
  
  	from myapp.models import MyModel
  	index.index_model(MyModel)
  	
- All indexable fields of `MyModel` are indexed. Even yet more fine granular is to index only a subset of fields::
+All indexable fields of `MyModel` are indexed. Even yet more fine granular is to index only a subset of fields::
  
  	from myapp.models import MyModel
  	index.index_model(MyModel, 'my_text_field', 'my_char_field')
  
- After all, you can tell the index **not** to index something::
+After all, you can tell the index **not** to index something::
  
  	index.index_app('django.contrib.comments', exlude=True)
  	
- or a model::
+or a model::
  
  	index.index_model(MyModel, exclude=True)
  	
- or some fields::
+or some fields::
  
  	index.index_model(MyModel, 'my_text_field', exclude=True)
  	
- **Note: Not indexing something outweighs indexing something!**
+**Note: Not indexing something outweighs indexing something!**
  
- For example, if you want to index a whole project, but don't want to index comments of the django.contrib.comments-app, just do::
+For example, if you want to index a whole project, but don't want to index comments of the django.contrib.comments-app, just do::
  
  	index.index_project()
  	index.index_app('django.contrib.comments', exclude=True)
  
- That's it about indexing.
+That's it about indexing.