Indexing.pl - Revision history

Drn@ecs.soton.ac.uk: Added actually file name in bold.

2022-01-30T10:21:52Z

Added actually file name in bold.

← Older revision		Revision as of 10:21, 30 January 2022
Line 2:		Line 2:
	{{cfgd}}		{{cfgd}}

	~~This file~~ contains configuration for indexing data objects.		'''indexing.pl''' contains configuration for indexing data objects.

	In particular this has configuration for whether indexing is enabled and if so the following configuration rules:		In particular this has configuration for whether indexing is enabled and if so the following configuration rules:

Drn@ecs.soton.ac.uk at 12:48, 23 January 2022

2022-01-23T12:48:50Z

← Older revision		Revision as of 12:48, 23 January 2022
Line 7:		Line 7:
	* '''<code>$c->{indexing}->{freetext_min_word_size} </code>''' - The minimum length a word in free-text field has to be to be indexed. The default is 3.		* '''<code>$c->{indexing}->{freetext_min_word_size} </code>''' - The minimum length a word in free-text field has to be to be indexed. The default is 3.
	* '''<code>$c->{indexing}->{freetext_stop_words}</code>''' - Words that should not be indexed in free-text fields, as they are too common (e.g. and, are, the, you, etc.).		* '''<code>$c->{indexing}->{freetext_stop_words}</code>''' - Words that should not be indexed in free-text fields, as they are too common (e.g. and, are, the, you, etc.).
	* '''<code>$c->{indexing}->{freetext_seperator_chars}</code>''' - Characters that separate two separate words in a free-text field (e.g. colon <tt>:</tt>, equals <tt>=</tt> hyphen <tt>-</tt>, full stop <tt>.</tt>, space <tt> </tt>, etc.).		* '''<code>$c->{indexing}->{freetext_seperator_chars}</code>''' - Characters that separate two separate words in a free-text field (e.g. colon <tt>:</tt>, equals <tt>=</tt> hyphen <tt>-</tt>, full stop <tt>.</tt>, space <tt> </tt>, etc.). N.B. ''seperator'' was a typo in the codebase that cannot now be fixed for legacy reasons.

	The file also contains the '''extract_words''' function for how individual words should be extracted from free-text. This may vary across different types of repository and some repositories may have edge cases they need to handle, so this has be purposefully designed as a user-defined function to facilitate bespoke requirements.		The file also contains the '''extract_words''' function for how individual words should be extracted from free-text. This may vary across different types of repository and some repositories may have edge cases they need to handle, so this has be purposefully designed as a user-defined function to facilitate bespoke requirements.

Drn@ecs.soton.ac.uk at 12:41, 23 January 2022

2022-01-23T12:41:50Z

← Older revision		Revision as of 12:41, 23 January 2022
Line 9:		Line 9:
	* '''<code>$c->{indexing}->{freetext_seperator_chars}</code>''' - Characters that separate two separate words in a free-text field (e.g. colon <tt>:</tt>, equals <tt>=</tt> hyphen <tt>-</tt>, full stop <tt>.</tt>, space <tt> </tt>, etc.).		* '''<code>$c->{indexing}->{freetext_seperator_chars}</code>''' - Characters that separate two separate words in a free-text field (e.g. colon <tt>:</tt>, equals <tt>=</tt> hyphen <tt>-</tt>, full stop <tt>.</tt>, space <tt> </tt>, etc.).

	The file also contains the '''extract_words'' function for how individual words should be extracted from free-text. This may vary across different types of repository and some repositories may have edge cases they need to handle, so this has be purposefully designed as a user-defined function to facilitate bespoke requirements.		The file also contains the '''extract_words''' function for how individual words should be extracted from free-text. This may vary across different types of repository and some repositories may have edge cases they need to handle, so this has be purposefully designed as a user-defined function to facilitate bespoke requirements.

Drn@ecs.soton.ac.uk: Added page about config file

2022-01-23T12:41:33Z

Added page about config file

New page

{{dirs}}
{{cfgd}}

This file contains configuration for indexing data objects.

In particular this has configuration for whether indexing is enabled and if so the following configuration rules:
* '''<code>$c->{indexing}->{freetext_min_word_size} </code>''' - The minimum length a word in free-text field has to be to be indexed. The default is 3.
* '''<code>$c->{indexing}->{freetext_stop_words}</code>''' - Words that should not be indexed in free-text fields, as they are too common (e.g. and, are, the, you, etc.).
* '''<code>$c->{indexing}->{freetext_seperator_chars}</code>''' - Characters that separate two separate words in a free-text field (e.g. colon <tt>:</tt>, equals <tt>=</tt> hyphen <tt>-</tt>, full stop <tt>.</tt>, space <tt> </tt>, etc.).

The file also contains the '''extract_words'' function for how individual words should be extracted from free-text. This may vary across different types of repository and some repositories may have edge cases they need to handle, so this has be purposefully designed as a user-defined function to facilitate bespoke requirements.