Frames - Revision history

John: /* Adding Frames to the System */

2022-05-17T14:51:04Z

Adding Frames to the System

← Older revision		Revision as of 14:51, 17 May 2022
Line 38:		Line 38:
	== Adding Frames to the System ==		== Adding Frames to the System ==

	Frames can be added to the system using the Telstar API.		Frames can be added to the system using the [[the Telstar API]].

	The Telstar API, in conjunction with the cross platform Telstar Util software, provides a simple method of creating and managing pages.		The Telstar API, in conjunction with the cross platform Telstar Util software, provides a simple method of creating and managing pages.

John: /* Adding Frames to the System */

2022-05-17T14:49:37Z

Adding Frames to the System

← Older revision		Revision as of 14:49, 17 May 2022
Line 38:		Line 38:
	== Adding Frames to the System ==		== Adding Frames to the System ==

	Frames can be added to the system using ~~either~~ the Telstar API.		Frames can be added to the system using the Telstar API.

	The Telstar API, in conjunction with the cross platform Telstar Util software, provides a simple method of creating and managing pages.		The Telstar API, in conjunction with the cross platform Telstar Util software, provides a simple method of creating and managing pages.

John: /* content */

2022-05-16T20:32:57Z

content

← Older revision		Revision as of 20:32, 16 May 2022
Line 235:		Line 235:
	Content types:		Content types:

			* '''zxnet''': If set, then the content will be treated as an zxnet editor url. This is converted to RawV before being rendered.
	* '''edit.tf''': If set, then the content will be treated as an edit.tf url. This is converted to RawV before being rendered.		* '''edit.tf''': If set, then the content will be treated as an edit.tf url. This is converted to RawV before being rendered.
	* '''markup''': If set, then the content will be treated as ''markup'' content. Full details of ''markup'' can be found in the section [[Markup]]		* '''markup''': If set, then the content will be treated as ''markup'' content. Full details of ''markup'' can be found in the section [[Markup]]

John at 20:32, 16 May 2022

2022-05-16T20:32:08Z

← Older revision		Revision as of 20:32, 16 May 2022
Line 17:		Line 17:
	}		}

	Shown below is a more complete example of a JSON defined frame. With this particular frame, the actual viewdata content has been created using the editor at http://edit.tf, this can be seen in the ''content.data'' and ''content.type'' keys. The example below is a simple information page with some simple routing (see [[Routing]]). Clicking the ''content.data'' link, or pasteing the value into a browser will show the page and allow it to be edited. It is not necessary to use the http://edit.tf editor, this is just one possible option.
			Shown below is a more complete example of a JSON defined frame. With this particular frame, the actual viewdata content has been created using the editor at http://edit.tf, this can be seen in the ''content.data'' and ''content.type'' keys. Both the edit.tf and zxnet (https://zxnet.co.uk/teletext/editor/) editors are supported. The example below is a simple information page with some simple routing (see [[Routing]]). Clicking the ''content.data'' link, or pasteing the value into a browser will show the page and allow it to be edited. It is not necessary to use the http://edit.tf editor, this is just one possible option.


	{		{

John: /* redirect */

2022-04-24T19:25:09Z

redirect

← Older revision		Revision as of 19:25, 24 April 2022
Line 212:		Line 212:
	{		{
	"PID": {		"PID": {
	"page-no": 9,		"page-no": 2,
	"frame-id": "a"		"frame-id": "a"
	},		},
	"redirect": {		"redirect": {
	"page-no": 9,		"page-no": 11,
	"frame-id": "a"		"frame-id": "a"
	},		},

John: /* redirect */

2022-04-24T19:24:19Z

redirect

← Older revision		Revision as of 19:24, 24 April 2022
Line 219:		Line 219:
	"frame-id": "a"		"frame-id": "a"
	},		},
	"visible: true		"visible": true
	}		}

John: /* redirect */

2022-04-24T19:23:21Z

redirect

@@ Line 207: / Line 207: @@
              "frame-id": "a"
          },
 === content ===

John: /* = Example 3 */

2022-04-20T22:43:43Z

= Example 3

← Older revision		Revision as of 22:43, 20 April 2022
Line 258:		Line 258:
	Note that this extended form of ''type'' only applies to edit.tf types.		Note that this extended form of ''type'' only applies to edit.tf types.

	==== Example 3 ===		==== Example 3 ====

	The merge data field can be used to add ''layers'' of markup data to the title area. For example the example above shows the Guardian logo. To add some alphagraphics text to this, an additional layer could be used e.g.		The merge data field can be used to add ''layers'' of markup data to the title area. For example the example above shows the Guardian logo. To add some alphagraphics text to this, an additional layer could be used e.g.

John at 22:33, 20 April 2022

2022-04-20T22:33:01Z

← Older revision		Revision as of 22:33, 20 April 2022
Line 115:		Line 115:
	"title": {		"title": {
	"data": "",		"data": "",
	"type": ""		"type": "",
			"merge-data": []
	},		},
	"routing-table": [		"routing-table": [
Line 231:		Line 232:
	Separating title from content in this way allows logos and header sections to be created for the title whilst using markup for the main content or visa-versa.		Separating title from content in this way allows logos and header sections to be created for the title whilst using markup for the main content or visa-versa.

	~~The~~ example ~~here is shown~~ blank meaning that only the data in the ''content'' section is displayed.		==== Example 1 ====

			In thi example the fields are blank meaning that only the data in the ''content'' section is displayed.

	"title": {		"title": {
	"data": "",		"data": "",
	"type": ""		"type": "",
			"merge-data": []
			},

			==== Example 2 ====

			In this example, the top 4 lines of the edit.tf content is displayed at the top of the page.

			"title": {
			"data": "https://edit.tf/#0:QIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECAvobotqBX__oECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIC_9AgQIEGv-gQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgL_0Cj4kQav6BAgQIECBAgQIECBAgQIECBAgQIECBAgQIECAuq64P6Dx__oECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECA",
			"type": "edit.tf",
			"merge-data": []
	},		},

			To take the top 5 lines, the ''type'' field can be extended as follows.

			"type": "edit.tf,5"

			Note that this extended form of ''type'' only applies to edit.tf types.

			==== Example 3 ===

			The merge data field can be used to add ''layers'' of markup data to the title area. For example the example above shows the Guardian logo. To add some alphagraphics text to this, an additional layer could be used e.g.

			"title": {
			"data": "https://edit.tf/#0:QIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECAvobotqBX__oECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIC_9AgQIEGv-gQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgL_0Cj4kQav6BAgQIECBAgQIECBAgQIECBAgQIECBAgQIECAuq64P6Dx__oECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECBAgQIECA",
			"type": "edit.tf,5",
			"merge-data": [
			"[w[ UK News]]"
			]
			},

			Note that any number of layers can be added, however, the merge layer must be defined as markup.

	=== routing table ===		=== routing table ===

	The routing table defines which pages are navigated ~~towhen~~ a user presses a key whilst viewing the frame. The table has 11 entries with the first 10 representing the keys 0-9, the final entry refers to the ''hash'' (return) key.		The routing table defines which pages are navigated to when a user presses a key whilst viewing the frame. The table has 11 entries with the first 10 representing the keys 0-9, the final entry refers to the ''hash'' (return) key.

	The example below shows the default routing table for frame 9a. If the user is viewing this frame and presses 1 the frame 91a will be loaded, assuming it exists. Pressing the ''hash'' (return) key will take the user back to frame 0a, the main index.		The example below shows the default routing table for frame 9a. If the user is viewing this frame and presses 1 the frame 91a will be loaded, assuming it exists. Pressing the ''hash'' (return) key will take the user back to frame 0a, the main index.

John at 08:06, 15 April 2022

2022-04-15T08:06:45Z

← Older revision		Revision as of 08:06, 15 April 2022
Line 3:		Line 3:
	The Telstar utility program simply interacts with the Telstar API which is a restful API. This can be used directly by any software making it simple to programitically manage pages and routing information.		The Telstar utility program simply interacts with the Telstar API which is a restful API. This can be used directly by any software making it simple to programitically manage pages and routing information.

	Frames are defined in JSON. The simplest frame that can be viewed on TELSTAR would be as follows. This would create a simple information frame with some flashing content. In this example [[Markup]] has been used within the content, however, other ~~contant~~ types can be used including edi.tf urls, see below.		Frames are defined in JSON. The simplest frame that can be viewed on TELSTAR would be as follows. This would create a simple information frame with some flashing content. In this example [[Markup]] has been used within the content, however, other content types can be used including edi.tf urls, see below.

	{		{