CuneiForm - ประวัติรุ่นแก้ไข

Tenko: /* General Form Head & Form Object */

2024-08-30T11:49:52Z

General Form Head & Form Object

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 18:49, 30 สิงหาคม 2567
บรรทัดที่ 310:		บรรทัดที่ 310:
	** '''proxy_submit_ele''': The mock element meant to be used instead of the form's own submit element. Use cases include the need to call additional functions before form submission and form chaining.		** '''proxy_submit_ele''': The mock element meant to be used instead of the form's own submit element. Use cases include the need to call additional functions before form submission and form chaining.
	** '''linked_modals''': An array collection of 'modal objects' linked to the form via search-and-fill relationships.		** '''linked_modals''': An array collection of 'modal objects' linked to the form via search-and-fill relationships.
			** '''expand_modals''': An array of the names of expansion modals linked to the form.

	* '''Field State & Type Attributes'''		* '''Field State & Type Attributes'''

Tenko: /* With Database Commit */

2024-07-23T01:32:19Z

With Database Commit

@@ บรรทัดที่ 816: / บรรทัดที่ 816: @@
 </syntaxhighlight>
-The key player of this pattern is the function '''{{code|gen_dbcommit_resp}}''' that handles the most repeated routines related to form validation and database commit.
+The key player of this pattern is the function '''[[Common Functions#gen_dbcommit_resp|gen_dbcommit_resp]]''' that handles the most repeated routines related to form validation and database commit.
 === Data Fetching Route ===

Tenko: /* Original Intentions */

2024-06-23T12:26:38Z

Original Intentions

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 19:26, 23 มิถุนายน 2567
บรรทัดที่ 28:		บรรทัดที่ 28:

	==== Original Intentions ====		==== Original Intentions ====
	Reading through the CuneiFox code base, one is sure to notice the excessive use of StringFields where one would expect DateFields, TimeFields, FloatFields, and IntegerFields as supported by WTForms. This design choice ~~stems~~ was made to address a challenging browser behaviour. Modern browsers tend to enforce formatting of fields marked as certain types based on the user's locale setting, which can be tied to either the operating system or the browser itself. This automatic formatting can be difficult to override or reverse, leading to inconsistencies and confusion on the user's part especially when switching workstations.		Reading through the CuneiFox code base, one is sure to notice the excessive use of StringFields where one would expect DateFields, TimeFields, FloatFields, and IntegerFields as supported by WTForms. This design choice was made to address a challenging browser behaviour. Modern browsers tend to enforce formatting of fields marked as certain types based on the user's locale setting, which can be tied to either the operating system or the browser itself. This automatic formatting can be difficult to override or reverse, leading to inconsistencies and confusion on the user's part, especially when switching workstations.

	To address this issue, CuneiFox developed its own value typing. Our approach applies custom-made JavaScript codes on unformatted and untyped (as far as the browser is aware) fields. This way, the formatting rendered on the client-side perfectly obeys the company's specific preferences within the CuneiFox system.		To address this issue, CuneiFox developed its own value typing. Our approach applies custom-made JavaScript codes to unformatted and untyped (as far as the browser is aware) fields. This way, the formatting rendered on the client-side perfectly obeys the company's specific preferences within the CuneiFox system.

	==== Current Incarnation ====		==== Current Incarnation ====

Tenko: /* Non-redirecting Form */

2024-06-19T04:17:08Z

Non-redirecting Form

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 11:17, 19 มิถุนายน 2567
บรรทัดที่ 718:		บรรทัดที่ 718:
	## If other tables and forms on the page are affected ('''{{code\|data.crossfill}}''': ''dict'': See note), re-populate them.		## If other tables and forms on the page are affected ('''{{code\|data.crossfill}}''': ''dict'': See note), re-populate them.
	## If the document-level verification pills must be manipulated ('''{{code\|data.docverify}}''': ''dict'': See note), do so.		## If the document-level verification pills must be manipulated ('''{{code\|data.docverify}}''': ''dict'': See note), do so.
	## If the form belongs to a table as the in-line form ({{code\|form_obj.in_table}}) or the fully-expanded form ({{code\|form_obj.table_linked}}), commit the change (if any) to the table as well by looking for '''{{code\|data.entry}}''' (~~shares format with the table data in~~ '''{{code\|data.crossfill}}'''~~, see note~~).		## If the form belongs to a table as the in-line form ({{code\|form_obj.in_table}}) or the fully-expanded form ({{code\|form_obj.table_linked}}), commit the change (if any) to the table as well by looking for '''{{code\|data.entry}}'''. (See notes under '''{{code\|data.crossfill}}''' below).
	## If the form belongs to a modal ({{code\|form_obj.in_modal}}), clear the modal's '''hide_mode''' attribute to {{code\|lang=javascript\|'plain'}}.		## If the form belongs to a modal ({{code\|form_obj.in_modal}}), clear the modal's '''hide_mode''' attribute to {{code\|lang=javascript\|'plain'}}.
	*# Where applicable, pack the transient data ('''{{code\|data._transient_data}}''': ''dict'') to {{code\|form_obj.transient_data}} and run each functions in {{code\|form_obj.post_submit_cmds}}.		*# Where applicable, pack the transient data ('''{{code\|data._transient_data}}''': ''dict'') to {{code\|form_obj.transient_data}} and run each functions in {{code\|form_obj.post_submit_cmds}}.
บรรทัดที่ 766:		บรรทัดที่ 766:
	... ]		... ]
	</syntaxhighlight>		</syntaxhighlight>


			'''{{code\|data.entry}}''' can take 2 forms:
			* For successful add/edit operations, it is formatted like a member array of the table data member in '''{{code\|data.crossfill}}'''.
			* For successful delete operations, it is simply the string '''{{code\|lang=javascript\|'deleted'}}'''.

Tenko: /* Search and Fill */

2024-06-18T08:05:45Z

Search and Fill

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 15:05, 18 มิถุนายน 2567
บรรทัดที่ 567:		บรรทัดที่ 567:
	=== Search and Fill ===		=== Search and Fill ===
	In the search-fill function, a CuneiForm take responsibility in two areas:		In the search-fill function, a CuneiForm take responsibility in two areas:
	# Invoking the corresponding [[~~CuneiTable~~\|search ~~table~~]] or [[~~CuneiModal~~\|search ~~modal~~]]. The control of the client-side behaviours is then relinquished to the ~~table or~~ modal.		# Invoking the corresponding [[CuneiModal\|search modal]] (which works along side its corresponding [[CuneiTable\|search table]]). The control of the client-side behaviours is then relinquished to the modal.
	# Once the ~~table or~~ modal has retrieved the selection result from the server, the client-side control is handed back to the CuneiForm to do the form filling.		# Once the modal has retrieved the selection result from the server (via the search table), the client-side control is handed back to the CuneiForm to do the form filling.

	''Refer to [[CuneiTable#Shortcut Route for Single-table Page & Search Table\|a subsection in the main CuneiTable article]] for a template of a Flask route that handles table populating and search result fetching.''		''Refer to [[CuneiTable#Shortcut Route for Single-table Page & Search Table\|a subsection in the main CuneiTable article]] for a template of a Flask route that handles table populating and search result fetching.''

Tenko: /* Filling */

2024-06-18T02:50:24Z

Filling

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 09:50, 18 มิถุนายน 2567
บรรทัดที่ 590:		บรรทัดที่ 590:
	Form filling after a search result fetch is handled by the JavaScript function '''{{code\|process_invoker}}''', which closely mimics the normal form filling routine with some additional flag manipulation.		Form filling after a search result fetch is handled by the JavaScript function '''{{code\|process_invoker}}''', which closely mimics the normal form filling routine with some additional flag manipulation.

	After filling, ~~user~~ might expect additional navigation behaviour (especially when the search is initiated by trigger paths #2 and #3). This navigational follow-up is handled by the JavaScript function '''{{code\|post_fill_invoker}}'''.		After filling, users might expect additional navigation behaviour (especially when the search is initiated by trigger paths #2 and #3). This navigational follow-up is handled by the JavaScript function '''{{code\|post_fill_invoker}}'''.

	Although these 2 functions resides in the JavaScript file for [[CuneiModal]], their inner workings are heavily based on CuneiForm logic.		Although these 2 functions resides in the JavaScript file for [[CuneiModal]], their inner workings are heavily based on CuneiForm logic.

Tenko: /* With Database Commit */

2024-06-14T04:29:48Z

With Database Commit

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 11:29, 14 มิถุนายน 2567
บรรทัดที่ 826:		บรรทัดที่ 826:
	* '''form''' ''(FlaskForm-CuneiForm)'': The form to read the committing data from.		* '''form''' ''(FlaskForm-CuneiForm)'': The form to read the committing data from.
	* '''perm_bit''' ''(int)'': The integer permission bit. This form of permission control is quite rigid and works well with single-table databases.		* '''perm_bit''' ''(int)'': The integer permission bit. This form of permission control is quite rigid and works well with single-table databases.
	* '''allowed_action''' ''({{{code\|lang=python\|{'add':<bool>, 'edit':<bool>, 'delete':<bool>} })'': A more complicated form of permission control. This allows for more precise control. However, it cannot be read directly from a permission database, but must be interpreted from the stored integer value upon use.		* '''allowed_action''' ''({{code\|lang=python\|{'add':<bool>, 'edit':<bool>, 'delete':<bool>} }})'': A more complicated form of permission control. This allows for more precise control. However, it cannot be read directly from a permission database, but must be interpreted from the stored integer value upon use.
	* '''suppress_success_msg''' ''(bool)'': Whether to show a message on action success.		* '''suppress_success_msg''' ''(bool)'': Whether to show a message on action success.
	* '''lock_on_add''' ''(bool)'': Lock the document upon successful add-type commit. (This works for multi-table databases by putting the current username in the '''editting''' column of the header table.)		* '''lock_on_add''' ''(bool)'': Lock the document upon successful add-type commit. (This works for multi-table databases by putting the current username in the '''editting''' column of the header table.)

Tenko: /* General Form Tail */

2024-06-13T06:00:13Z

General Form Tail

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 13:00, 13 มิถุนายน 2567
บรรทัดที่ 530:		บรรทัดที่ 530:

	'''{{code\|lang=javascript\|1= general_form_tail(form, populate=true, pack_del=false)}}'''		'''{{code\|lang=javascript\|1= general_form_tail(form, populate=true, pack_del=false)}}'''


	{\| style="margin-left:20px;"		{\| style="margin-left:20px;"

Tenko: /* General Form Head & Form Object */

2024-04-27T08:17:18Z

General Form Head & Form Object

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 15:17, 27 เมษายน 2567
บรรทัดที่ 292:		บรรทัดที่ 292:

	* '''Copied Attributes''' ''(See [[#Notes on Keyword Arguments]] for details)''		* '''Copied Attributes''' ''(See [[#Notes on Keyword Arguments]] for details)''
	** ~~'''skipseqs''',~~ '''firstonly~~'''~~, ~~'''~~in_table~~'''~~, ~~'''table_linked'''~~, ~~'''~~sequence_bound~~'''~~, ~~'''~~slim~~'''~~, ~~'''~~subslim~~'''~~, ~~'''seq'''~~, ~~'''populate_route'''~~, ~~'''redirect''', '''~~wait_long_process~~'''~~, '''~~track_route''',~~ and '''wait_redirect''': Takes on the exact value.		** '''firstonly, in_table, populate_route, redirect, seq, sequence_bound, skipseqs, slim, subslim, table_linked, track_route, wait_long_process,''' and '''wait_redirect''': Takes on the exact value.
	** '''instacalc''' and '''populate_suppress''': Takes on the exact value, but set to a blank dict {{code\|lang=javascript\|{} }} and a blank array {{code\|lang=javascript\|[]}}, respectively, when the value is {{code\|lang=python\|False}}.		** '''instacalc''' and '''populate_suppress''': Takes on the exact value, but set to a blank dict {{code\|lang=javascript\|{} }} and a blank array {{code\|lang=javascript\|[]}}, respectively, when the value is {{code\|lang=python\|False}}.
	** '''submit_id''': Takes on the exact value ''if the corresponding submit button does not require a confirm pop-up''. If a confirm pop-up is needed, the value is suffixed with {{code\|_fake}}, e.g. {{code\|lang=javascript\|'submit_fake'}}. (See [[#Buttons & Submits]] for more details.)		** '''submit_id''': Takes on the exact value ''if the corresponding submit button does not require a confirm pop-up''. If a confirm pop-up is needed, the value is suffixed with {{code\|_fake}}, e.g. {{code\|lang=javascript\|'submit_fake'}}. (See [[#Buttons & Submits]] for more details.)

Tenko: /* General Form Head & Form Object */

2024-04-27T05:39:33Z

General Form Head & Form Object

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 12:39, 27 เมษายน 2567
บรรทัดที่ 287:		บรรทัดที่ 287:
	Below is the list of and notes on form object attributes:		Below is the list of and notes on form object attributes:
	* '''Basic Attributes'''		* '''Basic Attributes'''
	** '''~~_id~~''': Takes on the value of {{code\|form._id}}.		** '''id''': Takes on the value of {{code\|form._id}}.
	** '''self_type''': Takes on value {{code\|lang=javascript\|'form'}}.		** '''self_type''': Takes on value {{code\|lang=javascript\|'form'}}.
	** '''token''': The CSRF Token of the form, used to verify the form submission request.		** '''token''': The CSRF Token of the form, used to verify the form submission request.

←รุ่นแก้ไขก่อนหน้า		รุ่นแก้ไขเมื่อ 11:17, 19 มิถุนายน 2567
บรรทัดที่ 718:		บรรทัดที่ 718:
	## If other tables and forms on the page are affected ('''{{code\|data.crossfill}}''': ''dict'': See note), re-populate them.		## If other tables and forms on the page are affected ('''{{code\|data.crossfill}}''': ''dict'': See note), re-populate them.
	## If the document-level verification pills must be manipulated ('''{{code\|data.docverify}}''': ''dict'': See note), do so.		## If the document-level verification pills must be manipulated ('''{{code\|data.docverify}}''': ''dict'': See note), do so.
	## If the form belongs to a table as the in-line form ({{code\|form_obj.in_table}}) or the fully-expanded form ({{code\|form_obj.table_linked}}), commit the change (if any) to the table as well by looking for '''{{code\|data.entry}}''' (~~shares format with the table data in~~ '''{{code\|data.crossfill}}'''~~, see note~~).		## If the form belongs to a table as the in-line form ({{code\|form_obj.in_table}}) or the fully-expanded form ({{code\|form_obj.table_linked}}), commit the change (if any) to the table as well by looking for '''{{code\|data.entry}}'''. (See notes under '''{{code\|data.crossfill}}''' below).
	## If the form belongs to a modal ({{code\|form_obj.in_modal}}), clear the modal's '''hide_mode''' attribute to {{code\|lang=javascript\|'plain'}}.		## If the form belongs to a modal ({{code\|form_obj.in_modal}}), clear the modal's '''hide_mode''' attribute to {{code\|lang=javascript\|'plain'}}.
	*# Where applicable, pack the transient data ('''{{code\|data._transient_data}}''': ''dict'') to {{code\|form_obj.transient_data}} and run each functions in {{code\|form_obj.post_submit_cmds}}.		*# Where applicable, pack the transient data ('''{{code\|data._transient_data}}''': ''dict'') to {{code\|form_obj.transient_data}} and run each functions in {{code\|form_obj.post_submit_cmds}}.
บรรทัดที่ 766:		บรรทัดที่ 766:
	... ]		... ]
	</syntaxhighlight>		</syntaxhighlight>


			'''{{code\|data.entry}}''' can take 2 forms:
			* For successful add/edit operations, it is formatted like a member array of the table data member in '''{{code\|data.crossfill}}'''.
			* For successful delete operations, it is simply the string '''{{code\|lang=javascript\|'deleted'}}'''.