Boolean field - Revision history

Drn@ecs.soton.ac.uk: Reinstate link to API page even though a redirect

2024-07-09T09:47:57Z

Reinstate link to API page even though a redirect

← Older revision		Revision as of 09:47, 9 July 2024
Line 64:		Line 64:

	== API ==		== API ==
			See [[API:EPrints/MetaField/Boolean\|API page]].

	In the code these fields are stored as strings containing <tt>TRUE</tt>, <tt>FALSE</tt> or <tt>undef</tt> if they are not set.		In the code these fields are stored as strings containing <tt>TRUE</tt>, <tt>FALSE</tt> or <tt>undef</tt> if they are not set.

Drn@ecs.soton.ac.uk: Removed link to API page (just a redirect to this)

2024-07-09T09:40:09Z

Removed link to API page (just a redirect to this)

← Older revision		Revision as of 09:40, 9 July 2024
Line 64:		Line 64:

	== API ==		== API ==
	~~See [[API:EPrints/MetaField/Boolean\|API page]].~~

	In the code these fields are stored as strings containing <tt>TRUE</tt>, <tt>FALSE</tt> or <tt>undef</tt> if they are not set.		In the code these fields are stored as strings containing <tt>TRUE</tt>, <tt>FALSE</tt> or <tt>undef</tt> if they are not set.

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-11T20:42:44Z

Additional Properties

← Older revision		Revision as of 20:42, 11 April 2023
Line 14:		Line 14:
	\|-		\|-
	\| '''input_style''' \|\| <tt>checkbox</tt> \|\| NO \|\| This controls how the field is rendered in input forms. May be one of <tt>menu</tt>, <tt>radio</tt> or <tt>checkbox</tt>. \|\|		\| '''input_style''' \|\| <tt>checkbox</tt> \|\| NO \|\| This controls how the field is rendered in input forms. May be one of <tt>menu</tt>, <tt>radio</tt> or <tt>checkbox</tt>. \|\|
	\|-
	~~\| '''text_index''' \|\| <tt>0</tt> \|\| NO \|\| Whether the text of the field is indexed. \|\| Different to default.~~
	\|-		\|-
	\| '''input_rows''' \|\| n/a \|\| NO \|\| Number of rows for select box in input form. \|\| Only applicable if <tt>input_style => 'menu'</tt>. If so, must be configured within field definition.		\| '''input_rows''' \|\| n/a \|\| NO \|\| Number of rows for select box in input form. \|\| Only applicable if <tt>input_style => 'menu'</tt>. If so, must be configured within field definition.

Drn@ecs.soton.ac.uk: /* Additional Properties */

2023-04-11T14:25:35Z

Additional Properties

@@ Line 11: / Line 11: @@
 == Additional Properties ==
 {| border="1" cellpadding="3" cellspacing="0"
-| name || default || description
+! Name !! Default Value !! Required !! Description !! Notes
 |-
 |}

Drn@ecs.soton.ac.uk at 09:40, 9 April 2023

2023-04-09T09:40:39Z

← Older revision		Revision as of 09:40, 9 April 2023
Line 9:		Line 9:
	** [[Boolean field]]		** [[Boolean field]]

	== Properties ==		== Additional Properties ==
	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
	\| name \|\| default \|\| description		\| name \|\| default \|\| description

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

2023-04-09T09:34:54Z

Database

← Older revision		Revision as of 09:34, 9 April 2023
Line 63:		Line 63:
	== Database ==		== Database ==
	Boolean fields are stored in the database as		Boolean fields are stored in the database as
			fieldname VARCHAR(5)
	fieldname ~~SET~~( ~~'TRUE', 'FALSE'~~ )

	== API ==		== API ==

Drn@ecs.soton.ac.uk: /* Required Phrases */

2023-04-09T09:25:06Z

Required Phrases

← Older revision		Revision as of 09:25, 9 April 2023
Line 24:		Line 24:

	== Required Phrases ==		== Required Phrases ==
			In addition to the [[Metadata#Required_Phrases\|standard metadata field phrases]]:

	=== menu style ===		=== menu style ===

Drn@ecs.soton.ac.uk at 08:42, 9 April 2023

2023-04-09T08:42:28Z

← Older revision		Revision as of 08:42, 9 April 2023
Line 1:		Line 1:
	{{fieldtypes}}		{{fieldtypes}}
	~~{{TOC limit\|2}}~~

	== Description ==		== Description ==

Drn@ecs.soton.ac.uk at 08:40, 9 April 2023

2023-04-09T08:40:30Z

← Older revision		Revision as of 08:40, 9 April 2023
Line 1:		Line 1:
	{{fieldtypes}}		{{fieldtypes}}
			{{TOC limit\|2}}

	== Description ==		== Description ==

Drn@ecs.soton.ac.uk: Moved description to top. Added link to API page.

2023-03-21T08:18:17Z

Moved description to top. Added link to API page.

← Older revision		Revision as of 08:18, 21 March 2023
Line 1:		Line 1:
	{{fieldtypes}}		{{fieldtypes}}


			== Description ==
			Describes a simple yes/no value. Unless the field has the ''required'' property set, it can actually have a third setting of unset. This can be useful as it distinguishes between a "False" and a "don't know/haven't filled this in yet". For example when asking if a paper is refereed, this is a boolean field. However it's not required as often someone isn't sure, and does not want to click "no" when that's not necessarily true.

	== Inheritance ==		== Inheritance ==
	* [[Metadata]]		* [[Metadata]]
	** [[Boolean field]]		** [[Boolean field]]

	~~== Description ==~~

	Describes a simple yes/no value. Unless the field has the ''required'' property set, it can actually have a third setting of unset. This can be useful as it distinguishes between a "False" and a "don't know/haven't filled this in yet". For example when asking if a paper is refereed, this is a boolean field. However it's not required as often someone isn't sure, and does not want to click "no" when that's not necessarily true.

	== Properties ==		== Properties ==

	{\| border="1" cellpadding="3" cellspacing="0"		{\| border="1" cellpadding="3" cellspacing="0"
	\| name \|\| default \|\| description		\| name \|\| default \|\| description
Line 61:		Line 59:

	<epp:phrase id="eprint_radio_myboolean"><label><epc:pin name="true"/>Yes, I like cheese.</label><br/><label><epc:pin name="false"/>No, cheese is bad.</label></epp:phrase>		<epp:phrase id="eprint_radio_myboolean"><label><epc:pin name="true"/>Yes, I like cheese.</label><br/><label><epc:pin name="false"/>No, cheese is bad.</label></epp:phrase>


	== Database ==		== Database ==

	Boolean fields are stored in the database as		Boolean fields are stored in the database as

Line 70:		Line 66:

	== API ==		== API ==
			See [[API:EPrints/MetaField/Boolean\|API page]].

	In the code these fields are stored as strings containing <tt>TRUE</tt>, <tt>FALSE</tt> or <tt>undef</tt> if they are not set.		In the code these fields are stored as strings containing <tt>TRUE</tt>, <tt>FALSE</tt> or <tt>undef</tt> if they are not set.