Json field - Revision history

Drn@ecs.soton.ac.uk: /* Installation */

2023-04-10T10:01:15Z

Installation

← Older revision		Revision as of 10:01, 10 April 2023
Line 13:		Line 13:

	=== Installation ===		=== Installation ===
	This module requires the <tt>HTML::Entities</tt> and <tt>JSON::Parse</tt> Perl libraries installed. Also requires <tt>jquery</tt> ingredient to be enabled in your [[~~EPrint~~ Flavour\|flavour's]] inc file. If you want to use the <tt>richtext</tt> sub-field type a [https://www.tiny.cloud/docs/tinymce/6/cloud-quick-start/ TinyMCE script] to be included either in a <tt><script></tt> tag in the archive's template or downloaded into the archive's <tt>cfg/static/javascript/auto/</tt> directory.		This module requires the <tt>HTML::Entities</tt> and <tt>JSON::Parse</tt> Perl libraries installed. Also requires <tt>jquery</tt> ingredient to be enabled in your [[EPrints_Glossary#Flavour\|flavour's]] inc file. If you want to use the <tt>richtext</tt> sub-field type a [https://www.tiny.cloud/docs/tinymce/6/cloud-quick-start/ TinyMCE script] to be included either in a <tt><script></tt> tag in the archive's template or downloaded into the archive's <tt>cfg/static/javascript/auto/</tt> directory.

	=== Usage ===		=== Usage ===

Drn@ecs.soton.ac.uk: Added syuff about sub-fields

2022-06-14T20:52:25Z

Added syuff about sub-fields

← Older revision		Revision as of 20:52, 14 June 2022
Line 13:		Line 13:

	=== Installation ===		=== Installation ===
	This module requires the <tt>HTML::Entities</tt> and <tt>JSON::Parse</tt> Perl libraries installed. Also requires <tt>jquery</tt> ingredient to be enabled in your [[EPrint Flavour\|flavour's]] inc file ~~and~~ a [https://www.tiny.cloud/docs/tinymce/6/cloud-quick-start/ TinyMCE script] to be included either in a <tt><script></tt> tag in the archive's template or downloaded into the archive's <tt>cfg/static/javascript/auto/</tt> directory.		This module requires the <tt>HTML::Entities</tt> and <tt>JSON::Parse</tt> Perl libraries installed. Also requires <tt>jquery</tt> ingredient to be enabled in your [[EPrint Flavour\|flavour's]] inc file. If you want to use the <tt>richtext</tt> sub-field type a [https://www.tiny.cloud/docs/tinymce/6/cloud-quick-start/ TinyMCE script] to be included either in a <tt><script></tt> tag in the archive's template or downloaded into the archive's <tt>cfg/static/javascript/auto/</tt> directory.

	=== Usage ===		=== Usage ===
Line 41:		Line 41:
	}		}

	=== Compatible ~~Field~~ Types ===		=== Compatible Sub-field Types ===
	For the sub-fields the following field types are currently compatible. These ~~are separate and~~ should not be ~~confused~~ with EPrints MetaField types:		For the sub-fields the following sub-field types are currently compatible. These should not be conflated with EPrints MetaField types, of which some are emulated by the types below but are configured differently:
	* '''<tt>text</tt>''' - A single line text, (i.e. HTML <tt><input type="text"></tt>)		* '''<tt>text</tt>''' - A single line text, (i.e. HTML <tt><input type="text"></tt>)
	* '''<tt>number</tt>''' - A numerical text field, (i.e. HTML <tt><input type="number"></tt>)		* '''<tt>number</tt>''' - A numerical text field, (i.e. HTML <tt><input type="number"></tt>)

Drn@ecs.soton.ac.uk: /* Installation */

2022-06-14T20:49:21Z

Installation

← Older revision		Revision as of 20:49, 14 June 2022
Line 13:		Line 13:

	=== Installation ===		=== Installation ===
	This module requires the <tt>HTML::Entities</tt> and <tt>JSON::Parse</tt> Perl libraries installed. Also requires <tt>jquery</tt> ingredient to be enabled in your [[EPrint Flavour\|flavour's]] inc file and a [https://www.tiny.cloud/docs/tinymce/6/cloud-quick-start/ TinyMCE script] to be included either in a <tt><script&gt</tt> tag in the archive's template or downloaded into the archive's <tt>cfg/static/javascript/auto/</tt> directory.		This module requires the <tt>HTML::Entities</tt> and <tt>JSON::Parse</tt> Perl libraries installed. Also requires <tt>jquery</tt> ingredient to be enabled in your [[EPrint Flavour\|flavour's]] inc file and a [https://www.tiny.cloud/docs/tinymce/6/cloud-quick-start/ TinyMCE script] to be included either in a <tt><script></tt> tag in the archive's template or downloaded into the archive's <tt>cfg/static/javascript/auto/</tt> directory.

	=== Usage ===		=== Usage ===

Drn@ecs.soton.ac.uk: /* Installation */

2022-06-14T20:49:05Z

Installation

← Older revision		Revision as of 20:49, 14 June 2022
Line 13:		Line 13:

	=== Installation ===		=== Installation ===
	This module requires the <tt>HTML::Entities</tt> and <tt>JSON::Parse</tt> Perl libraries installed.		This module requires the <tt>HTML::Entities</tt> and <tt>JSON::Parse</tt> Perl libraries installed. Also requires <tt>jquery</tt> ingredient to be enabled in your [[EPrint Flavour\|flavour's]] inc file and a [https://www.tiny.cloud/docs/tinymce/6/cloud-quick-start/ TinyMCE script] to be included either in a <tt><script&gt</tt> tag in the archive's template or downloaded into the archive's <tt>cfg/static/javascript/auto/</tt> directory.

	=== Usage ===		=== Usage ===

Drn@ecs.soton.ac.uk: /* Usage */

2022-06-14T19:26:22Z

Usage

← Older revision		Revision as of 19:26, 14 June 2022
Line 35:		Line 35:
	{		{
	name => "subfield4",		name => "subfield4",
	type => "namedset"		type => "namedset",
	set_name => "example_set"		set_name => "example_set"
	}		}

Drn@ecs.soton.ac.uk: /* Compatible Field Types */

2022-06-14T19:04:14Z

Compatible Field Types

← Older revision		Revision as of 19:04, 14 June 2022
Line 45:		Line 45:
	* '''<tt>text</tt>''' - A single line text, (i.e. HTML <tt><input type="text"></tt>)		* '''<tt>text</tt>''' - A single line text, (i.e. HTML <tt><input type="text"></tt>)
	* '''<tt>number</tt>''' - A numerical text field, (i.e. HTML <tt><input type="number"></tt>)		* '''<tt>number</tt>''' - A numerical text field, (i.e. HTML <tt><input type="number"></tt>)
	* '''<tt>longtext ~~field~~</tt>''' - a multi-line text field (i.e. HTML <tt><textarea></tt>)		* '''<tt>longtext</tt>''' - a multi-line text field (i.e. HTML <tt><textarea></tt>)
	* '''<tt>boolean</tt>''' - a checkbox field (i.e. HTML <tt><input type="checkbox"></tt>)		* '''<tt>boolean</tt>''' - a checkbox field (i.e. HTML <tt><input type="checkbox"></tt>)
	* '''<tt>richtext</tt>''' - a multi-line text field with a WYSIWYG editor		* '''<tt>richtext</tt>''' - a multi-line text field with a WYSIWYG editor

Drn@ecs.soton.ac.uk: /* Compatible Field Types */

2022-06-14T19:04:01Z

Compatible Field Types

← Older revision		Revision as of 19:04, 14 June 2022
Line 42:		Line 42:

	=== Compatible Field Types ===		=== Compatible Field Types ===
	For the sub-fields the following field types are currently compatible:		For the sub-fields the following field types are currently compatible. These are separate and should not be confused with EPrints MetaField types:
	* ~~[[Text field]]~~		* '''<tt>text</tt>''' - A single line text, (i.e. HTML <tt><input type="text"></tt>)
	* ~~[[Int~~ field]]		* '''<tt>number</tt>''' - A numerical text field, (i.e. HTML <tt><input type="number"></tt>)
	* ~~[[Longtext~~ field]]		* '''<tt>longtext field</tt>''' - a multi-line text field (i.e. HTML <tt><textarea></tt>)
	* ~~[[Boolean~~ field]]		* '''<tt>boolean</tt>''' - a checkbox field (i.e. HTML <tt><input type="checkbox"></tt>)
	* ~~[[Namedset~~ field]]		* '''<tt>richtext</tt>''' - a multi-line text field with a WYSIWYG editor
	~~Other field types are likely to be compatible as long as there values can be embedded within JSON syntax~~.		* '''<tt>namedset'''</tt> - a set of options (i.e. HTML <tt><select&gt</tt>

	These all render as their ~~standard~~ EPrints ~~counterparts~~ would, however are rendered by JavaScript instead of the standard EPrints form renderer.		These all render as their comparative EPrints MetaFields would, however are rendered by JavaScript instead of the standard EPrints form renderer.

	The corresponding phrases for each subfield are in the format:		The corresponding phrases for each subfield are in the format:

Drn@ecs.soton.ac.uk: /* Compatible Field Types */

2022-06-14T18:39:34Z

Compatible Field Types

← Older revision		Revision as of 18:39, 14 June 2022
Line 44:		Line 44:
	For the sub-fields the following field types are currently compatible:		For the sub-fields the following field types are currently compatible:
	* [[Text field]]		* [[Text field]]
	* [[~~Integer~~ field]]		* [[Int field]]
	* [[Longtext field]]		* [[Longtext field]]
	* [[Boolean field]]		* [[Boolean field]]
	* [[Namedset field]]		* [[Namedset field]]
	Other field types are ~~likley~~ to be compatible as long as there values can be embedded within JSON syntax.		Other field types are likely to be compatible as long as there values can be embedded within JSON syntax.

	These all render as their standard EPrints counterparts would, however are rendered by JavaScript instead of the standard EPrints form renderer.		These all render as their standard EPrints counterparts would, however are rendered by JavaScript instead of the standard EPrints form renderer.

Drn@ecs.soton.ac.uk at 18:38, 14 June 2022

2022-06-14T18:38:45Z

← Older revision		Revision as of 18:38, 14 June 2022
Line 77:		Line 77:

	=== Lookup ===		=== Lookup ===
	You can provide an <tt>input_lookup_url</tt> as per standard ~~[[Category:MetaField\|~~MetaFields]].		You can provide an <tt>input_lookup_url</tt> as per standard MetaFields.

	When added, each subfield will have lookup capabilities. It will send the following as parameters to the <tt>input_lookup_url</tt>		When added, each subfield will have lookup capabilities. It will send the following as parameters to the <tt>input_lookup_url</tt>

Drn@ecs.soton.ac.uk: /* Lookup */

2022-06-14T18:38:11Z

Lookup

← Older revision		Revision as of 18:38, 14 June 2022
Line 77:		Line 77:

	=== Lookup ===		=== Lookup ===
	You can provide an <tt>input_lookup_url</tt> as per standard [[Category::MetaField\|MetaFields]].		You can provide an <tt>input_lookup_url</tt> as per standard [[Category:MetaField\|MetaFields]].

	When added, each subfield will have lookup capabilities. It will send the following as parameters to the <tt>input_lookup_url</tt>		When added, each subfield will have lookup capabilities. It will send the following as parameters to the <tt>input_lookup_url</tt>
Line 85:		Line 85:

	A basic CGI script that accepts these parameters and uses them to lookup on a particular subfield is provided.		A basic CGI script that accepts these parameters and uses them to lookup on a particular subfield is provided.


	== Properties ==		== Properties ==