root	index	SignPuddle 3 API	https://signpuddle.com/server
	line	> v3.0.0
	line	
	line	Welcome to the SignPuddle 3 API.
	line	The API is defined with two types of source, two types of documentation, and a live page of HTML and JavaScript.
	line	
	line	+ Source: [ApiTxt format](../src/index.txt) and [JSON objects](../src/index.json)
	line	+ Documents: [API Blueprint](../doc/index.md) and [Stand Alone HTML](../doc/index.htm)
	line	+ Live Page: [API Interface](../api/index.html) and [JavaScript](../api/index.js)
	line	
	line	The API is divided into several sections.
	line	This main document includes all of the sections.
	line	Each section is available separately as well.
	line	
	line	## HTTP Request Methods
	line	
	line	The SignPuddle 3 server accepts HTTP request methods of GET, POST, PUT, and DELETE.
	line	+ GET - retrieve information without altering the server
	line	+ POST - add information to the server with each request
	line	+ PUT - update information on the server
	line	+ DELETE - remove information on the server.
	line	## HTTP Response Statuses
	line	
	line	The SignPuddle 3 server responds with status codes.
	line	
	line	### Success Codes
	line	
	line	+ 200 OK
	line	+ 201 Created
	line	+ 202 Accepted
	line	+ 204 No Content
	line	
	line	### Redirect Codes
	line	
	line	+ 300 Multiple Choices
	line	+ 304 No Modified
	line	+ 307 Temporary Redirect
	line	+ 308 Permanent Redirect
	line	
	line	### Client Error Codes
	line	
	line	+ 400 Bad Request
	line	+ 403 Forbidden
	line	+ 404 Not Found
	line	+ 409 Conflict
	line	+ 429 Too Many Requests
	line	
	line	### Server Error Codes
	line	
	line	+ 500 Internal Server Error
	line	+ 501 Not Implemented
	line	+ 503 Service Unavailable
	line	
	line	## HTTP Headers
	line	
	line	Headers pass additional information about the request or response.
	line	
	line	### Headers
	line	
	line	+ Content-Type - the MIME type of the response
	line	+ ETag - an entity tag used to validate cached values
	line	+ Expires - date after which response is stale
	line	+ Location - used for redirect or for newly created resource
	line	+ If-None-Match - request header compared to ETag value, response status 304 if matching
	line	+ If-Modified-Since - request header, causes response status 304 if unmodified
	line	+ Last-Modified - response header, used with If-Modified-Since request header
	line	
group	user	SignPuddle 3 collections are organized by country and language codes
	line	+ Source: [ApiTxt format](../src/user.txt) and [JSON objects](../src/user.json)
	line	+ Documents: [API Blueprint](../doc/user.md) and [Stand Alone HTML](../doc/user.htm)
	line	+ Live Page: [API Interface](../api/user.html) and [JavaScript](../api/user.js)
	route	/user/who	Who uses SignWriting?	List of countries with size and activity.
		method	GET	Retrieve country list	The available countries where signs are available.
			request	user-who
				response	200	text/plain
					body	BR
					body	US
	route	/user/pass	User pass	A string for accounting and validation
		method	POST	String for accounting and validation
			code	  echo json_pretty(userPass());
			request	user pass
				response	200	text/plain
					body	{"pass": "90c19ce2076db097c75b3406e966a6b6","ip": "192.168.254.2"}
		method	PUT	Check pass against user
			code	  $data = $app->request->getbody();
			code	  $data = json_decode($data,true);
			code	  verifyPass($data['username'],$data['pass']);
			code	  $app->response->setStatus(204);
			code	  return;
			request	user pass verify
				line	+ Attributes
				line	    + username: anonymous (string) - name of the user
				line	    + pass: af77... (string) - pass for session validation
				body	{"username":"anonymous","pass":"af77..."}
				response	204
	route	/user/login	User login	Validation of user with validated password
		method	PUT	Process log in to server
			code	  $data = $app->request->getbody();
			code	  $data = json_decode($data,true);
			code	  $results = userVerify($data['username'],$data['pass'],$data['validated']);
			code	  echo json_pretty($results);
			request	verify user	application/json
				line	+ Attributes
				line	    + username: anonymous (string) - name of the user
				line	    + pass: af77... (string) - pass for session validation
				line	    + validated: 2793f... (string) - validated pass mixed with password
				body	{"username":"anonymous","pass":"af77...","validated":"2793f..."}
				response	200	application/json
					line	response text here
					body	{"user-profile":""}
	route	/user/{name}	User profile	User details
		parameter	name	slevinski	string	The name of a user
		method	PUT	Update user profile	Updates the profile of the user
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$user = userVerified($pass);
			code	if ($user!=$name) haltForbidden($user . " not " . $name);
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	userProfileUpdate($name,$data);
			code	$app->response->setStatus(204);
			code	return;
			request	user-update
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	204
		method	POST	Register new user	Creates and returns a new user
			request	user-add
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	200	text/plain
					body	profile created and returned
	route	/user/{name}/password	User password	User password resource
		parameter	name	slevinski	string	The name of a user
		method	POST	Update user password	Updates the password of the user
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$user = userVerified($pass,true);
			code	if (!$user) haltForbidden();
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	$old = isset($data['old'])?$data['old']:'';
			code	$new = isset($data['new'])?$data['new']:'';
			code	if ($old && $new){
			code	  userPasswordUpdate($name,$old,$new);
			code	  $app->response->setStatus(204);
			code	  return;
			code	} else {
			code	  haltBadRequest();
			code	}
			request	user-update-password	plain/text
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				body	{"old":"149603e6c03516362a8da23f624db945","new":"22af645d1859cb5ca6da0c484f1f37ea"}
				response	204
		method	PUT	Reset user password	Creates a temporary password for the user
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$user = userVerified($pass,true);
			code	if (!$user) haltForbidden();
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	$user = isset($data['user'])?$data['user']:'';
			code	if ($user){
			code	  userPasswordReset($user);
			code	  $app->response->setStatus(204);
			code	  return;
			code	} else {
			code	  haltBadRequest();
			code	}
			request	user-password-reset	plain/text
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	204
	route	/user/email	User email requests	Requests for email of username or password reset
		method	GET	List of user email requests	User email requests for username or passwords
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightscheck("",$pass,SP_ADMIN);
			code	$users = userEmailRequests();
			code	echo json_pretty($users);
			code	return;
			request	user-email-request
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	200	text/plain
					body	[{"name":"slevinski","email":"slevinski@signwriting.org","temp":"username"}]
	route	/user/email/{email}	Username lookup	Forgot username email lookup
		parameter	email	slevinski@signwriting.org	string	The email for a user
		method	PUT	Lookup username	Creates a request for email of username
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$user = userVerified($pass,true);
			code	if (!$user) haltForbidden();
			code	userNameLookup($email);
			code	$app->response->setStatus(204);
			code	return;
			request	user-name-lookup
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	204
group	collection	Resources related to collections in general
	line	+ Source: [ApiTxt format](../src/collection.txt) and [JSON objects](../src/collection.json)
	line	+ Documents: [API Blueprint](../doc/collection.md) and [Stand Alone HTML](../doc/collection.htm)
	line	+ Live Page: [API Interface](../api/collection.html) and [JavaScript](../api/collection.js)
	route	/collection{?name}	Collections available
		parameter	name	sp3	string	partial collection name
		method	GET	Get available collections
			code	$collections = collectionListing($name);
			code	if (count($collections)){
			code	  echo json_pretty($collections);
			code	} else {
			code	  $app->response->setStatus(204);
			code	}
			code	return;
			response	200	text/plain
				body	["en-US-interface-sp3"]
	route	/collection/{name}	Collection resource	Specific collection
		parameter	name	`en-US-interface-sp3`	string	The name of a collection
		method	DELETE	delete collection
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	collectionDelete($name,$pass);
			code	collectionSecurityDelete($name,$pass);
			code	collectionManageDelete($name,$pass);
			code	$app->response->setStatus(204);
			request	the removal of a collection
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	204
	route	/collection/{name}/entry/{ik}/image/{num}	Collection entry image resource	Specific image for collection entry
		parameter	name	`ase-US-dictionary-public`	string	The name of an dictionary
		parameter	ik	11244	string	An id number or key string
		parameter	num	1	string	The image number of 1 thru 4
		method	PUT	update image for collection entry
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	collectionImageUpdate($name,$ik,$num,$data,$pass);
			code	$app->response->setStatus(204);
			code	return;
			request	an update for an existing dictionary entry	application/json
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				body	{
				body	  "file": "name.png",
				body	  "data": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD..."
				body	}
				response	204
		method	DELETE	remove dictionary entry
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	collectionImageDelete($name,$ik,$num,$pass);
			code	$app->response->setStatus(204);
			request	the removal of a collection entry image
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	204
	route	/collection/{name}/stats	Collection statistics	Statistics about the collection
		parameter	name	`ase-US-dictionary-public`	required,string	The name of a dictionary
		method	GET	Get collection statistics
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	header('Last-Modified: ' . $lastModified);
			code	$output = json_pretty(collectionStats($name));
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $output;
			request	collections statistics
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				response	200	text/plain
					body	[{"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}]
	route	/collection/security	Collections security	Security settings for all collections
		method	GET	Get collections security
			code	$headers = getHeaders();
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$lastModified = lastModifiedCollection();
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	header('Last-Modified: ' . $lastModified);
			code	echo json_pretty(collectionsSecurity());
			request	collections security
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				response	200	text/plain
					body	[{"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}]
	route	/collection/{name}/security	Collection security	Details about the collection security
		parameter	name	`en-US-interface-sp3`	required,string	The name of the collection
		method	GET	retrieve collection security
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	echo json_pretty(collectionSecurity($name));
			request	interface security
				response	200	text/plain
					body	{"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}
		method	PUT	Update collection security
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	collectionSecurityUpdate($name,$data,$pass);
			code	$app->response->setStatus(204);
			code	return;
			request	an update for an existing entry	text/plain
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				body	{"name": "en-US-interface-sp3","code": "ui1","title": "English Interface for SignPuddle 3","user": "slevinski","created_at": "","view_pass": 0,"add_pass": 1,"edit_pass": 1,"register_level": 0,"upload_level": 4}
				response	204
		method	DELETE	Remove security for collection
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	collectionSecurityDelete($name,$pass);
			code	$app->response->setStatus(204);
			request	the deletion of collection security
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	204
	route	/collection/{name}/users	Collection users
		parameter	name	`ase-US-dictionary-public`	string	collection name
		method	GET	Get collection users
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	echo json_pretty(collectionUsers($name));
			response	200	text/plain
				body	[{"user": "test_user","security": 3}]
	route	/collection/manage/unknown	Management for unknown collections
		method	GET	Get list of unknown collections with user management
			code	echo json_pretty(collectionManageUnknown());
			response	200	text/plain
				body	["es-US-interface-sp3"]
	route	/collection/{name}/manage	Collection users management
		parameter	name	`ase-US-dictionary-public`	string	collection name
		method	GET	Get collection management
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	echo json_pretty(collectionUsersDetail($name,$pass));
			request	collection management
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	200	text/plain
					body	[{"name": "test_user","display": "Test Editor","email": "testing@gmail.com","security": 3}]
		method	PUT	Update collection management
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	collectionManageUpdate($name,$data,$pass);
			code	$app->response->setStatus(204);
			code	return;
			request	an update for collection management
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				body	{"user":"slevinski","security":4}
				response	204
		method	DELETE	Remove user management for collection
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	collectionManageDelete($name,$pass);
			code	$app->response->setStatus(204);
			request	the removal of user management for a collection
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	204
	route	/collection/{name}/manage/{user}	Collection user
		parameter	name	`ase-US-dictionary-public`	string	collection name
		parameter	user	`slevinski`	string	user name
		method	DELETE	Remove user from collection management
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	collectionManageRemove($name,$user,$pass);
			code	$app->response->setStatus(204);
			request	the removal of a user from collection management
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	204
	route	/collection/{name}/request/{source}	Collection Request Copy
		parameter	name	`es-US-interface-sp3`	required,string	The name of the new collection
		parameter	source	`en-US-interface-sp3`	required,string	The name of the source collection
		method	POST	request the creation of a new collection
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$user = userVerified($pass);
			code	if (!$user) haltForbidden();
			code	rightsCheck($source,$pass,SP_VIEW);
			code	$err = invalidName($source);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$parts = explode("-",$source);
			code	$err = invalidName($name,$parts[2]);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$dir = 'data/db/';
			code	$infile = $dir . $source . ".db";
			code	$outfile = $dir . $name . ".db";
			code	if (!file_exists($infile)) haltBadRequest('Source collection does not exist: ' . $source);
			code	if (file_exists($outfile)) haltBadRequest('Collection already exists: ' . $name);
			code	if (copy($infile,$outfile)){
			code	  $data = array();
			code	  $data["user"] = $user;
			code	  $data["security"] = SP_EDIT;
			code	  collectionManageUpdate($name,$data,$pass,true);
			code	
			code	  $data = $app->request->getbody();
			code	  $data = json_decode($data,true);
			code	  $title = isset($data['title'])?$data['title']:'New Collection';
			code	  $data = array();
			code	  $data["title"] = $title;
			code	  $data["user"] = "admin";
			code	  $data["view_pass"] = 0;
			code	  $data["add_pass"] = 1;
			code	  $data["edit_pass"] = 1;
			code	  $data["register_level"] = 0;
			code	  $data["upload_level"] = 4;
			code	  collectionSecurityUpdate($name,$data,$pass,true);
			code	  $app->response->setStatus(204);
			code	  return;
			code	} else {
			code	  haltForbidden();
			code	}
			request	new collection from source
				header	Pass	5ffab638bde372b4fa63bb6f8484595d
				response	204
group	interface	Resources related to interface collections
	line	+ Source: [ApiTxt format](../src/interface.txt) and [JSON objects](../src/interface.json)
	line	+ Documents: [API Blueprint](../doc/interface.md) and [Stand Alone HTML](../doc/interface.htm)
	line	+ Live Page: [API Interface](../api/interface.html) and [JavaScript](../api/interface.js)
	route	/interface{?name}	Interfaces available
		parameter	name	sp3	string	partial interface name
		method	GET	Get available interfaces
			code	$dir = 'data/db/';
			code	$ext = '.db';
			code	$out = [];
			code	if ($name){
			code	  if (strpos($name,"interface")!==false){
			code	    $interfaces = $dir . '*' . $name . '*' . $ext;
			code	    $files = glob($interfaces);
			code	  } else {
			code	    $interfaces = $dir . '*interface*' . $name . '*' . $ext;
			code	    $files = glob($interfaces);
			code	    if (count($files)==0) {
			code	      $interfaces = $dir . '*' . $name . '*interface*' . $ext;
			code	      $files = glob($interfaces);
			code	    }
			code	  }
			code	} else {
			code	  $interfaces = $dir . '*interface*' . $ext;
			code	  $files = glob($interfaces);
			code	}
			code	foreach ($files as $filename) {
			code	  $out[] = str_replace($ext,'',str_replace($dir,'',$filename));
			code	}
			code	if (count($out)){
			code	  echo json_pretty($out);
			code	} else {
			code	  $app->response->setStatus(204);
			code	}
			code	return;
			response	200	text/plain
				body	["en-US-interface-sp3"]
	route	/interface/{name}{?update}	Interface resource	Access to available interfaces
		parameter	name	`en-US-interface-sp3`	required,string	The name of an interface
		parameter	update	1	optional,number	Forces a rewrite of the interface for json and txt formats
		method	GET	retrieve interface
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	if (strpos($name,'.')){
			code	  $parts = explode('.',$name);
			code	  $name = $parts[0];
			code	  $format = $parts[1];
			code	  if (!in_array($format,['db','txt','json'])){
			code	    haltNotFound();
			code	  }
			code	} else {
			code	  $format = 'json';
			code	}
			code	$dir = 'data/' . $format . '/';
			code	$ext = '.' . $format;
			code	$file = $dir . $name . $ext;
			code	$err = invalidName($name);
			code	if ($err){
			code	  $files = glob('data/db/' . $name . '*interface-sp3.db');
			code	  if (count($files)==0){
			code	    haltBadRequest($err);
			code	  } else {
			code		$name = str_replace(".db",'',str_replace('data/db/','',$files[0]));
			code	  }
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check  && !$update){
			code	  haltNotModified();
			code	}
			code	if ($format=='json' && (!file_exists($file) || $update)) {
			code	  $json = interface2json($name);
			code	  file_put_contents($file,$json);
			code	} else if ($format=='txt' && (!file_exists($file) || $update)) {
			code	  $txt = interface2txt($name);
			code	  file_put_contents($file,$txt);
			code	}
			code	if(file_exists($file)) {
			code	  header('Last-Modified: ' . $lastModified);
			code	  $searchTime = searchtime($timein);
			code	  header("Search-Time: " . $searchTime);
			code	  getFile($file);
			code	} else {
			code	  haltNotFound();
			code	}
			request	interface text
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				response	200	text/plain
					body	print.buttons.main<TAB>message<TAB>description<TAB>icon
	route	/interface/{name}/key	Interface keys	Access to interface keys
		parameter	name	`en-US-interface-sp3`	required,string	The name of an interface
		method	GET	retrieve interface keys
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	header('Last-Modified: ' . $lastModified);
			code	echo json_pretty(interfaceKeys($name,$pass));
			request	interface keys
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	["print.buttons.main"]
	route	/interface/{name}/search/{text}	Interface entries search	Search interface for text
		parameter	name	`en-US-interface-sp3`	required,string	The name of an interface
		parameter	text	`SignPuddle`	required,string	The text for searching
		method	GET	retrieve matching entries
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	echo json_pretty(interfaceSearch($name,$text,$pass));
			request	matching interface entries
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	[
					body	  {
					body	    "key": "print.buttons.main",
					body	    "message": "Print it!"
					body	  }
					body	]
	route	/interface/{name}/entry	Interface entry resource	Entries for interface
		parameter	name	`en-US-interface-sp3`	string	The name of an interface
		method	POST	add interface entry
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	if (!$pass){
			code	  haltForbidden();
			code	}
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	interfaceEntryNew($name,$data,$pass);
			code	$app->response->setStatus(201);
			code	return;
			request	add new interface entry	application/json
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				body	{"key":"new.key.one", "message":"UI text","description":"about the text","icon":"search"}
				response	201	text/plain
					body	...
	route	/interface/{name}/entry/{key}	Interface entry resource for key	Specific entries for interface
		parameter	name	`en-US-interface-sp3`	string	The name of an interface
		parameter	key	system.button.open	string	The name of an interface key
		method	GET	retrieve interface entry
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$entries = interfaceKeySearch($name,$key,$pass);
			code	if (!$entries){
			code	  haltNoContent();
			code	}
			code	$lastModified = max(array_map(function($o) {return $o->updated_at;},$entries));
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	header('Last-Modified: ' . $lastModified);
			code	echo json_pretty($entries);
			request	an interface entry
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	...
		method	PUT	update interface entry
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	interfaceEntryUpdate($name,$key,$data,$pass);
			code	$app->response->setStatus(204);
			code	return;
			request	an update for an existing entry
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				body	{"key":"new.key.one", "message":"UI text","description":"about the text","icon":"search"}
				response	204
		method	DELETE	remove interface entry
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	interfaceEntryDelete($name,$key,$pass);
			code	$app->response->setStatus(204);
			request	the removal of an interface entry
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	204
group	dictionary	Resources related to dictionary collections
	line	+ Source: [ApiTxt format](../src/dictionary.txt) and [JSON objects](../src/dictionary.json)
	line	+ Documents: [API Blueprint](../doc/dictionary.md) and [Stand Alone HTML](../doc/dictionary.htm)
	line	+ Live Page: [API Dictionary](../api/dictionary.html) and [JavaScript](../api/dictionary.js)
	route	/dictionary{?name}	Dictionaries available
		parameter	name	public	string	partial dictionary name
		method	GET	Get available dictionaries
			code	$dir = 'data/db/';
			code	$ext = '.db';
			code	$out = [];
			code	if ($name){
			code	  if (strpos($name,"dictionary")!==false){
			code	    $dictionaries = $dir . '*' . $name . '*' . $ext;
			code	    $files = glob($dictionaries);
			code	  } else {
			code	    $dictionaries = $dir . '*dictionary*' . $name . '*' . $ext;
			code	    $files = glob($dictionaries);
			code	    if (count($files)==0) {
			code	      $dictionaries = $dir . '*' . $name . '*dictionary*' . $ext;
			code	      $files = glob($dictionaries);
			code	    }
			code	  }
			code	} else {
			code	  $dictionaries = $dir . '*dictionary*' . $ext;
			code	  $files = glob($dictionaries);
			code	}
			code	foreach ($files as $filename) {
			code	  $out[] = str_replace($ext,'',str_replace($dir,'',$filename));
			code	}
			code	if (count($out)){
			code	  echo json_pretty($out);
			code	} else {
			code	  $app->response->setStatus(204);
			code	}
			code	return;
			response	200	text/plain
				body	["ase-US-dictionary-public"]
	route	/dictionary/{name}{?update}	Dictionary resource	Access to available dictionaries
		parameter	name	`ase-US-dictionary-public`	required,string	The name of an dictionary
		parameter	update	1	optional,number	Forces a rewrite of the dictionary for json and txt formats
		method	GET	retrieve dictionary
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	if (strpos($name,'.')){
			code	  $parts = explode('.',$name);
			code	  $name = $parts[0];
			code	  $format = $parts[1];
			code	  if (!in_array($format,['db','txt','json'])){
			code	    haltNotFound();
			code	  }
			code	} else {
			code	  $format = 'json';
			code	}
			code	$dir = 'data/' . $format . '/';
			code	$ext = '.' . $format;
			code	$file = $dir . $name . $ext;
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check  && !$update){
			code	  haltNotModified();
			code	}
			code	if ($format=='json' && (!file_exists($file) || $update)) {
			code	  $json = dictionary2json($name);
			code	  file_put_contents($file,$json);
			code	} else if ($format=='txt' && (!file_exists($file) || $update)) {
			code	  $txt = dictionary2txt($name);
			code	  file_put_contents($file,$txt);
			code	}
			code	if(file_exists($file)) {
			code	  header('Last-Modified: ' . $lastModified);
			code	  $searchTime = searchtime($timein);
			code	  header("Search-Time: " . $searchTime);
			code	  getFile($file);
			code	} else {
			code	  haltNotFound();
			code	}
			request	dictionary text
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				response	200	text/plain
					body	1<TAB>𝠀񂱡񂇙񆿃𝠃𝤝𝤔񂇙𝣰𝣹񆿃𝤎𝤁񂱡𝣽𝤀<TAB>test zero<TAB>test zero<TAB>we are testing SignPuddle 1.6<TAB>Val ;-)<TAB>{"video":"<iframe width=\"425\" height=\"349\" src=\"http:\/\/www.youtube.com\/embed\/RTniYA1lTDM\" frameborder=\"0\" allowfullscreen><\/iframe>"}<TAB>Val<TAB>2011-07-20T17:39:02Z<TAB>2011-07-20T17:42:09Z
	route	/dictionary/{name}/signs	List of dictionary signs	The signs in the dictionary
		parameter	name	`ase-US-dictionary-public`	string	The name of an dictionary
		method	GET	retrieve dictionary signs
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	header('Last-Modified: ' . $lastModified);
			code	$output = dictionarySigns($name);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $output;
			request	dictionary text
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				response	200	text/plain
					body	𝠀񂱡񂇙񆿃𝠃𝤝𝤔񂇙𝣰𝣹񆿃𝤎𝤁񂱡𝣽𝤀
	route	/dictionary/{name}/signtexts	List of dictionary signtexts	The signtexts in the dictionary
		parameter	name	`ase-US-dictionary-public`	string	The name of an dictionary
		method	GET	retrieve dictionary signtexts
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	header('Last-Modified: ' . $lastModified);
			code	$output = dictionarySigntexts($name);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $output;
			request	dictionary text
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				response	200	text/plain
					body	𝠀񂱡񂇙񆿃𝠃𝤝𝤔񂇙𝣰𝣹񆿃𝤎𝤁񂱡𝣽𝤀
	route	/dictionary/{name}/entry	Dictionary entry resource	Entries for dictionary
		parameter	name	`ase-US-dictionary-public`	string	The name of an dictionary
		method	POST	add dictionary entry
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	echo dictionaryEntryNew($name,$data,$pass);
			code	$app->response->setStatus(201);
			code	return;
			request	add new dictionary entry	application/json
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				body	{
				body	  "sign": "\ud836\udc03\ud836\udd44\ud836\udd19\ud8ef\udfa1\ud836\udcf4\ud836\udcf4\ud8dd\udc54\ud836\udcc8\ud836\udcfc\ud8dd\udc42\ud836\udd26\ud836\udcfa\ud8c8\uddd2\ud836\udd15\ud836\udcee\ud8c8\uddda\ud836\udce0\ud836\udcef",
				body	  "terms": [
				body	    "Malaysia"
				body	  ],
				body	  "signtext": "",
				body	  "text": "",
				body	  "source": "Conference Maastricht",
				body	  "detail": {}
				body	}  
				response	201	text/plain
					body	777
	route	/dictionary/{name}/entry/{id}	Dictionary entry resource for id	Specific entries for dictionary
		parameter	name	`ase-US-dictionary-public`	string	The name of an dictionary
		parameter	id	11244	string	An id numbers
		method	PUT	update dictionary entry
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	$data = $app->request->getbody();
			code	$data = json_decode($data,true);
			code	dictionaryEntryUpdate($name,$id,$data,$pass);
			code	$app->response->setStatus(204);
			code	return;
			request	an update for an existing dictionary entry	application/json
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				body	{
				body	  "sign": "\ud836\udc03\ud836\udd44\ud836\udd19\ud8ef\udfa1\ud836\udcf4\ud836\udcf4\ud8dd\udc54\ud836\udcc8\ud836\udcfc\ud8dd\udc42\ud836\udd26\ud836\udcfa\ud8c8\uddd2\ud836\udd15\ud836\udcee\ud8c8\uddda\ud836\udce0\ud836\udcef",
				body	  "terms": [
				body	    "Malaysia"
				body	  ],
				body	  "signtext": "",
				body	  "text": "",
				body	  "source": "Conference Maastricht",
				body	  "detail": {}
				body	}  
				response	204
		method	DELETE	remove dictionary entry
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	dictionaryEntryDelete($name,$id,$pass);
			code	$app->response->setStatus(204);
			request	the removal of an dictionary entry
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	204
	route	/dictionary/{name}/search{?offset,limit,filter,sort,results}	Search dictionary	Searching dictionary signs
		parameter	name	`ase-US-dictionary-public`	required,string	The name of a dictionary
		parameter	offset	0	number	Start of search results
		parameter	limit	10	number	Number of search results
		parameter	filter	user=Val	string	restrict search results
		parameter	sort	created_at	string	Field for sorting results
		parameter	results	sign	string	Type of results: entries, sign, term, terms
		method	GET	retrieve dictionary results of searching
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	$output = json_pretty(dictionarySearch($name,$offset,$limit,$filter,$sort,$results));
			code	header('Last-Modified: ' . $lastModified);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $output;
			request	dictionary query results
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	{
					body	  "total": 1,
					body	  "data": [
					body	    [
					body	      "1",
					body	      "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
					body	    ]
					body	  ]
					body	}
	route	/dictionary/{name}/search/id/{id}{?offset,limit,filter,sort,results}	Search dictionary with ids	Specific entries for dictionary
		parameter	name	`ase-US-dictionary-public`	string	The name of an dictionary
		parameter	id	1-4,5	string	A list of one or more id numbers
		parameter	offset	0	number	Start of search results
		parameter	limit	10	number	Number of search results
		parameter	filter	user=Val	string	restrict search results
		parameter	sort	created_at	string	Field for sorting results
		parameter	results	sign	string	Type of results: entries, sign, term, terms
		method	GET	retrieve dictionary entry
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	$output = json_pretty(dictionarySearchId($name,$id,$offset,$limit,$filter,$sort,$results));
			code	header('Last-Modified: ' . $lastModified);
			code	echo $output;
			request	an dictionary entry
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	[
					body	  {
					body	    "id": "1",
					body	    "sign": "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00",
					body	    "terms": [
					body	      "test zero"
					body	    ],
					body	    "lower": [
					body	      "test zero"
					body	    ],
					body	    "signtext": "",
					body	    "text": "we are testing SignPuddle 1.6",
					body	    "source": "Val ;-)",
					body	    "detail": {
					body	      "video": "<iframe width=\"425\" height=\"349\" src=\"http:\/\/www.youtube.com\/embed\/RTniYA1lTDM\" frameborder=\"0\" allowfullscreen><\/iframe>"
					body	    },
					body	    "user": "Val",
					body	    "created_at": "2011-07-20T17:39:02Z",
					body	    "updated_at": "2011-07-20T17:42:09Z"
					body	  }
					body	]
	route	/dictionary/{name}/search/sign/{query}{?offset,limit,filter,sort,results}	Search signs with query string	Query string access to dictionary signs
		parameter	name	`ase-US-dictionary-public`	required,string	The name of a dictionary
		parameter	query	Q	required,string	A query string
		parameter	offset	0	number	Start of search results
		parameter	limit	10	number	Number of search results
		parameter	filter	user=Val	string	restrict search results
		parameter	sort	created_at	string	Field for sorting results
		parameter	results	sign	string	Type of results: entries, sign, term, terms
		method	GET	retrieve dictionary results of searching signs with query string
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	header('Last-Modified: ' . $lastModified);
			code	$output = json_pretty(dictionarySearchSign($name,$query,$offset,$limit,$filter,$sort,$results));
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $output;
			request	dictionary query results
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	{
					body	  "total": 1,
					body	  "data": [
					body	    [
					body	      "1",
					body	      "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
					body	    ]
					body	  ]
					body	}
	route	/dictionary/{name}/search/signtext/{query}{?offset,limit,filter,sort,results}	Search signtexts with query string	Query string access to dictionary signtexts
		parameter	name	`ase-US-dictionary-public`	required,string	The name of a dictionary
		parameter	query	Q	required,string	A query string
		parameter	offset	0	number	Start of search results
		parameter	limit	10	number	Number of search results
		parameter	filter	user=Val	string	restrict search results
		parameter	sort	created_at	string	Field for sorting results
		parameter	results	sign	string	Type of results: entries, signtext, term, terms
		method	GET	retrieve dictionary results of searching signtexts with query string
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check){
			code	  haltNotModified();
			code	}
			code	header('Last-Modified: ' . $lastModified);
			code	$output = json_pretty(dictionarySearchSigntext($name,$query,$offset,$limit,$filter,$sort,$results));
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $output;
			request	dictionary query results
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	{
					body	  "total": 1,
					body	  "data": [
					body	    [
					body	      "1",
					body	      "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
					body	    ]
					body	  ]
					body	}
	route	/dictionary/{name}/search/terms/{text}{?type,case,offset,limit,filter,sort,results}	Dictionary terms search	Search dictionary terms for text
		parameter	name	`ase-US-dictionary-public`	required,string	The name of an dictionary
		parameter	text	`SignPuddle`	required,string	The text for searching
		parameter	type	exact	string	Type of search of start, end, or exact
		parameter	case	0	number	Case sensitive search
		parameter	offset	0	number	Start of search results
		parameter	limit	10	number	Number of search results
		parameter	filter	user=Val	string	restrict search results
		parameter	sort	created_at	string	Field for sorting results
		parameter	results	sign	string	Type of results: entries, sign, term, terms
		method	GET	retrieve matching entries
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$output = json_pretty(dictionarySearchTerms($name,$text,$type,$case, $offset, $limit, $filter, $sort,$results));
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $output;
			request	matching dictionary entries
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	{
					body	  "total": 1,
					body	  "data": [
					body	    [
					body	      "1",
					body	      "\ud836\udc00\ud8cb\udc61\ud8c8\uddd9\ud8db\udfc3\ud836\udc03\ud836\udd1d\ud836\udd14\ud8c8\uddd9\ud836\udcf0\ud836\udcf9\ud8db\udfc3\ud836\udd0e\ud836\udd01\ud8cb\udc61\ud836\udcfd\ud836\udd00"
					body	    ]
					body	  ]
					body	}
	route	/dictionary/{name}/alphabet{?update}	Dictionary symbol subset	Create alphabet from dictionary signs
		parameter	name	`ase-US-dictionary-public`	required,string	The name of an dictionary
		parameter	update	1	optional,number	Forces a rewrite of the alphabet
		method	GET	generate alphabet from dictionary contents
			code	$headers = getHeaders();
			code	$pass = isset($headers['Pass'])?$headers['Pass']:'';
			code	rightsCheck($name,$pass,SP_VIEW);
			code	$check = isset($headers['If-Modified-Since'])?$headers['If-Modified-Since']:'';
			code	if ($name=="iswa-2010"){
			code	  echo json_pretty(dictionaryISWA());
			code	  return;
			code	}
			code	$err = invalidName($name);
			code	if ($err){
			code	  haltBadRequest($err);
			code	}
			code	$lastModified = lastModified($name);
			code	if ($lastModified <= $check  && !$update){
			code	  haltNotModified();
			code	}
			code	
			code	$alphabet = str_replace('-dictionary-','-alphabet-',$name);
			code	$file = 'data/json/' . $alphabet . '.json';
			code	if (!$update){
			code	  if (!file_exists($file)) {
			code	    $update = 1;
			code	  } else {
			code	    $check = date ("Y-m-d\TH:i:s", filemtime($file));
			code	    $check =  new DateTime($check);
			code	    $check->setTimezone(new DateTimeZone('UTC'));
			code	    $check = $check->format('Y-m-d\TH:i:s\Z');
			code	    if ($lastModified>$check){
			code	      $update = 1;
			code	    }
			code	  }
			code	}
			code	if ($update) {
			code	  $json = json_pretty(dictionaryAlphabet($name,$lastModified));
			code	  file_put_contents($file,$json);
			code	}
			code	if(file_exists($file)) {
			code	  header('Last-Modified: ' . $lastModified);
			code	  $searchTime = searchtime($timein);
			code	  header("Search-Time: " . $searchTime);
			code	  getFile($file);
			code	} else {
			code	  haltNotFound();
			code	}
			request	dictionary query results
				header	If-Modified-Since	2019-01-16T16:56:19.175Z
				header	Pass	724fd4b4438fba9d0c5ab89d0833e5c9
				response	200	text/plain
					body	{"name": "ase-US-alphabet-public","data": []}
group	tools	Resources related to tools
	line	+ Source: [ApiTxt format](../src/tools.txt) and [JSON objects](../src/tools.json)
	line	+ Documents: [API Blueprint](../doc/tools.md) and [Stand Alone HTML](../doc/tools.htm)
	line	+ Live Page: [API Interface](../api/tools.html) and [JavaScript](../api/tools.js)
	route	/tools/	tools index
		method	GET	Get the tools index
			response	200	text/plain
				body	Available routes:
				body	
				body	/tools/
				body	/tools/test{?text}
				body	/tools/define
				body	/tools/define/{section}
				body	/tools/define/{section}/{part}
				body	/tools/parse{?text,utf}
				body	/tools/encode{?text,slash}
				body	/tools/decode{?text}
				body	/tools/utf8{?text}
	route	/tools/define	Character definition tree
		line	The definition tree for character mapping
		method	GET	Get main define
			code	$define = SignWriting\define();
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo json_pretty($define);
			response	200	text/plain;charset=utf-8
				body	{
				body	  "utf-8": {},
				body	  "utf-16": {},
				body	  "utf-32": {},
				body	  "fsw": {},
				body	  "swu": {},
				body	  "style": {}
				body	}
	route	/tools/define/{section}	Section definition
		line	A section of the definition tree
		parameter	section	fsw	string	The name of section
		method	GET	Get section define
			code	global $regex_define;
			code	if ($section == "regex"){
			code	  return $regex_define();
			code	}
			code	global $sample_define;
			code	if ($section == "sample"){
			code	  return $sample_define();
			code	}
			code	$define = SignWriting\define($section);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo json_pretty($define);
			response	200	text/plain;charset=utf-8
				body	{
				body	  "sign": [],
				body	  "spatial": [],
				body	  "symbol": [],
				body	  "coord": [],
				body	  "prefix": [],
				body	  "box": [],
				body	  "query": []
				body	}
	route	/tools/define/{section}/{part}	Part definition
		line	A part of the section definition
		parameter	section	swu	string	The name of section
		parameter	part	symbol	string	The part of the definition
		method	GET	Get part define
			code	$define = SignWriting\define($section,$part);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo json_pretty($define);
			response	200	text/plain;charset=utf-8
				body	[
				body	  "individual symbol",
				body	  "S10000",
				body	  "[\\x{40000}-\\x{4F428}]"
				body	]
	route	/tools/parse{?text,utf}	Parse text
		line	A function to analyze text and parse it into individual components
		parameter	text	S10000	string	The text to parse
		parameter	utf	32	string	The UTF number of 8, 16, 32 or 'x'
		method	GET	Get parse results
			code	if (!in_array($utf,[8,16,32,'x'])){
			code	  $utf = 16;
			code	}
			code	$parse = SignWriting\parse($text);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	$json = json_pretty($parse);
			code	echo SignWriting\cast($json,$utf);
			response	200	text/plain;charset=utf-8
				body	{
				body	  "fsw": {
				body	    "symbol": [
				body	      "S10000"
				body	    ]
				body	  },
				body	  "query": {
				body	    "base": [
				body	      100
				body	    ],
				body	    "symbol": [
				body	      "S10000"
				body	    ]
				body	  }
				body	}
	route	/tools/encode{?text,slash}	Encode text
		line	A function to encode SignWriting in Unicode (SWU) as UTF-16
		parameter	text	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚	string	The text to encode
		parameter	slash	1	number	The number of slashes for escaping
		method	GET	Get encoded query string
			code	$encode = SignWriting\encode($text,$slash);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $encode;
			response	200	text/plain;charset=utf-8
				body	\uD836\uDC00\uD8D8\uDD31\uD8E2\uDC23\uD8F4\uDE61\uD836\uDC03\uD836\uDD1B\uD836\uDD35\uD8F4\uDE61\uD836\uDCF4\uD836\uDCF5\uD8D8\uDD31\uD836\uDD0C\uD836\uDD06\uD8E2\uDC23\uD836\uDD09\uD836\uDD1A
	route	/tools/decode{?text}	Decode text
		line	A function to decode SignWriting in Unicode (SWU) from UTF-16
		parameter	text	\\uD836\\uDC00	string	The text to decode
		method	GET	Get decoded query string
			code	$decode = SignWriting\decode($text);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $decode;
			response	200	text/plain;charset=utf-8
				body	𝠀
	route	/tools/utf8{?text}	UTF-8 encode text
		parameter	text	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚	string	The text to encode
		method	GET	Get utf-8 encoded query string
			code	$encode = SignWriting\utf8($text);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $encode;
			response	200	text/plain;charset=utf-8
				body	%F0%9D%A0%80%F1%86%84%B1%F1%88%A0%A3%F1%8D%89%A1%F0%9D%A0%83%F0%9D%A4%9B%F0%9D%A4%B5%F1%8D%89%A1%F0%9D%A3%B4%F0%9D%A3%B5%F1%86%84%B1%F0%9D%A4%8C%F0%9D%A4%86%F1%88%A0%A3%F0%9D%A4%89%F0%9D%A4%9A
	route	/tools/test{?text,opt1,opt2}	Test with input
		line	A general purpose function for testing
		parameter	text	S10000	string	Input for testing
		parameter	opt1	AS	string	Option one for testing
		parameter	opt2	AS	string	Option two for testing
		method	GET	Get test results
			code	$test = SignWriting\test($text,$opt1,$opt2);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $test;
			response	200	text/plain;charset=utf-8
				body	test output
group	FSW	Resources related to Formal SignWriting in ASCII (FSW)
	line	+ Source: [ApiTxt format](../src/fsw.txt) and [JSON objects](../src/fsw.json)
	line	+ Documents: [API Blueprint](../doc/fsw.md) and [Stand Alone HTML](../doc/fsw.htm)
	line	+ Live Page: [API Interface](../api/fsw.html) and [JavaScript](../api/fsw.js)
	route	/fsw{?text,style}	FSW Word
		parameter	text	AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520	string	The name of sign
		parameter	style	true	boolean,optional	Flag to include styling string
		method	GET	First FSW string
			code	$fsw = SignWriting\fsw($text,$style);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $fsw;
			request	one Formal SignWriting in ASCII string
				response	200	text/plain;charset=utf-8
					body	AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520
	route	/fsw/all{?text,style}	FSW Text
		parameter	text	AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520	string	The name of sign
		parameter	style	1	number	Flag to include styling string
		method	GET	All FSW strings
			code	$fsw = SignWriting\fswAll($text,$style);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $fsw;
			request	many Formal SignWriting in ASCII string
				response	200	text/plain;charset=utf-8
					body	AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520
	route	/fsw/swu{?text}	FSW to SWU
		parameter	text	AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520	string	The name of sign
		method	GET	Text with FSW strings
			code	$swu = SignWriting\fsw2swu($text);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $swu;
			request	SWU conversion of FSW string
				line	transformation from ASCII to Unicode characters.
				response	200	text/plain;charset=utf-8
					line	requires font SuttonSignWritingOneD
					body	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚
	route	/fsw/svg/{text}	SVG image
		line	Create a stand-alone SVG image using Formal SignWriting in ASCII (FSW)
		parameter	text	AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520	string	The name of sign
		method	GET	Retrieve stand alone SVG image
			code	$req = $app->request();
			code	if ($req->get('throwStatus')=='500') {haltNoDatabase();}
			code	$svg = SignWriting\svg($text);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $svg;
			request	collection text
				response	200	image/svg+xml;charset=utf-8
					body	<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="39" height="64" viewBox="482 483 39 64">
					body	  <text style="font-size:0%;">AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520</text>
					body	  <svg x='482' y='483'><g transform="translate(0.149874875465,34.7500790925) scale(0.00988906872676,-0.00988956850125)"><path class="sym-line" fill="black" d="M1528 3484 c-592 -92 -1088 -447 -1348 -963 -125 -249 -180 -485 -180 -771 0 -480 183 -911 529 -1242 350 -336 780 -508 1271 -508 451 0 864 150 1193 434 326 281 517 620 591 1051 21 121 21 409 0 530 -43 252 -114 444 -237 639 -282 453 -741 750 -1284 831 -127 19 -413 18 -535 -1z m607 -173 c583 -126 1038 -523 1224 -1069 59 -173 75 -277 75 -492 0 -165 -3 -211 -22 -300 -71 -327 -228 -611 -458 -829 -186 -177 -381 -295 -614 -374 -176 -60 -282 -78 -490 -84 -247 -7 -416 19 -628 97 -549 201 -944 674 -1043 1250 -17 97 -17 383 0 480 99 576 495 1050 1043 1250 105 38 177 58 303 81 143 26 467 21 610 -10z M1720 1800 l0 -600 80 0 80 0 0 600 0 600 -80 0 -80 0 0 -600z"/></g></svg>
					body	  <svg x='506' y='500'><g transform="translate(0.0,15.0) scale(0.01,-0.01)"><path class="sym-fill" fill="white" d="M200 750 l0 -550 300 0 300 0 0 550 0 550 -300 0 -300 0 0 -550z"/><path class="sym-line" fill="black" d="M0 750 l0 -750 750 0 750 0 0 750 0 750 -750 0 -750 0 0 -750z m800 0 l0 -550 -300 0 -300 0 0 550 0 550 300 0 300 0 0 -550z"/></g></svg>
					body	  <svg x='503' y='520'><g transform="translate(0.196840829729,26.6999810561) scale(0.00975214136907,-0.00983390502079)"><path class="sym-line" fill="black" d="M345 2350 l-350 -350 325 -325 325 -325 -325 -325 -325 -325 353 -353 352 -352 0 303 0 302 350 0 350 0 0 100 0 100 -350 0 -350 0 0 550 0 550 350 0 350 0 0 100 0 100 -350 0 -350 0 -2 300 -3 300 -350 -350z M1600 1350 l0 -1350 100 0 100 0 0 1350 0 1350 -100 0 -100 0 0 -1350z"/></g></svg>
					body	</svg>
	route	/fsw/svg/font/{text}	SVG with font
		line	Create an SVG with font using Formal SignWriting in ASCII (FSW)
		parameter	text	AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520	string	The name of sign
		method	GET	Retrieve SVG with font
			code	$req = $app->request();
			code	if ($req->get('throwStatus')=='500') {haltNoDatabase();}
			code	$svg = SignWriting\svg($text,true);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $svg;
			request	collection text
				response	200	image/svg+xml;charset=utf-8
					body	<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="49" height="69" viewBox="476 466 49 69">
					body	  <text font-size="0">AS10011S10019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475</text>
					body	  <g transform="translate(483,510)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􋛩</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󻛩</text></g>
					body	  <g transform="translate(501,466)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􀀒</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󰀒</text></g>
					body	  <g transform="translate(510,500)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􋚥</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󻚥</text></g>
					body	  <g transform="translate(476,475)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􀀚</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󰀚</text></g>
					body	</svg>
group	swu	Resources related to Formal SignWriting in ASCII (SWU)
	line	+ Source: [ApiTxt format](../src/swu.txt) and [JSON objects](../src/swu.json)
	line	+ Documents: [API Blueprint](../doc/swu.md) and [Stand Alone HTML](../doc/swu.htm)
	line	+ Live Page: [API Interface](../api/swu.html) and [JavaScript](../api/swu.js)
	route	/swu{?text,style}	SWU Word
		parameter	text	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚	string	The name of sign
		parameter	style	1	number	Flag to include styling string
		method	GET	first SWU string
			code	$timein = microtime(true);
			code	$swu = SignWriting\swu($text,$style);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $swu;
			request	one Formal SignWriting in ASCII string
				response	200	text/plain;charset=utf-8
					body	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚
	route	/swu/all{?text,style}	SWU Text
		parameter	text	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚	string	The name of sign
		parameter	style	1	number	Flag to include styling string
		method	GET	all SWU strings
			code	$timein = microtime(true);
			code	$swu = SignWriting\swuAll($text,$style);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $swu;
			request	many Formal SignWriting in ASCII string
				response	200	text/plain;charset=utf-8
					body	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚
	route	/swu/fsw{?text}	SWU to FSW
		parameter	text	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚	string	The name of sign
		method	GET	text with SWU strings
			code	$timein = microtime(true);
			code	$fsw = SignWriting\swu2fsw($text);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $fsw;
			request	original text with Formal SignWriting in ASCII inside
				response	200	text/plain;charset=utf-8
					body	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚
	route	/swu/svg/{text}	SVG image
		line	Create a stand-alone SVG image using Formal SignWriting in ASCII (SWU)
		parameter	text	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚	string	The name of sign
		method	GET	retrieve stand-alone SVG image
			code	$timein = microtime(true);
			code	$req = $app->request();
			code	if ($req->get('throwStatus')=='500') {haltNoDatabase();}
			code	$svg = SignWriting\svg($text);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $svg;
			request	collection text
				response	200	image/svg+xml;charset=utf-8
					body	<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="39" height="64" viewBox="482 483 39 64">
					body	  <text style="font-size:0%;">𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚</text>
					body	  <svg x='482' y='483'><g transform="translate(0.149874875465,34.7500790925) scale(0.00988906872676,-0.00988956850125)"><path class="sym-line" fill="black" d="M1528 3484 c-592 -92 -1088 -447 -1348 -963 -125 -249 -180 -485 -180 -771 0 -480 183 -911 529 -1242 350 -336 780 -508 1271 -508 451 0 864 150 1193 434 326 281 517 620 591 1051 21 121 21 409 0 530 -43 252 -114 444 -237 639 -282 453 -741 750 -1284 831 -127 19 -413 18 -535 -1z m607 -173 c583 -126 1038 -523 1224 -1069 59 -173 75 -277 75 -492 0 -165 -3 -211 -22 -300 -71 -327 -228 -611 -458 -829 -186 -177 -381 -295 -614 -374 -176 -60 -282 -78 -490 -84 -247 -7 -416 19 -628 97 -549 201 -944 674 -1043 1250 -17 97 -17 383 0 480 99 576 495 1050 1043 1250 105 38 177 58 303 81 143 26 467 21 610 -10z M1720 1800 l0 -600 80 0 80 0 0 600 0 600 -80 0 -80 0 0 -600z"/></g></svg>
					body	  <svg x='506' y='500'><g transform="translate(0.0,15.0) scale(0.01,-0.01)"><path class="sym-fill" fill="white" d="M200 750 l0 -550 300 0 300 0 0 550 0 550 -300 0 -300 0 0 -550z"/><path class="sym-line" fill="black" d="M0 750 l0 -750 750 0 750 0 0 750 0 750 -750 0 -750 0 0 -750z m800 0 l0 -550 -300 0 -300 0 0 550 0 550 300 0 300 0 0 -550z"/></g></svg>
					body	  <svg x='503' y='520'><g transform="translate(0.196840829729,26.6999810561) scale(0.00975214136907,-0.00983390502079)"><path class="sym-line" fill="black" d="M345 2350 l-350 -350 325 -325 325 -325 -325 -325 -325 -325 353 -353 352 -352 0 303 0 302 350 0 350 0 0 100 0 100 -350 0 -350 0 0 550 0 550 350 0 350 0 0 100 0 100 -350 0 -350 0 -2 300 -3 300 -350 -350z M1600 1350 l0 -1350 100 0 100 0 0 1350 0 1350 -100 0 -100 0 0 -1350z"/></g></svg>
					body	</svg>
	route	/swu/svg/font/{text}	SVG with font
		line	Create an SVG with font using Formal SignWriting in ASCII (SWU)
		parameter	text	𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚	string	The name of sign
		method	GET	retrieve SVG with font
			code	$timein = microtime(true);
			code	$req = $app->request();
			code	if ($req->get('throwStatus')=='500') {haltNoDatabase();}
			code	$svg = SignWriting\svg($text,true);
			code	$searchTime = searchtime($timein);
			code	header("Search-Time: " . $searchTime);
			code	echo $svg;
			request	collection text
				response	200	image/svg+xml;charset=utf-8
					body	<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="49" height="69" viewBox="476 466 49 69">
					body	  <text font-size="0">𝠀񆄱񈠣񍉡𝠃𝤛𝤵񍉡𝣴𝣵񆄱𝤌𝤆񈠣𝤉𝤚</text>
					body	  <g transform="translate(483,510)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􋛩</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󻛩</text></g>
					body	  <g transform="translate(501,466)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􀀒</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󰀒</text></g>
					body	  <g transform="translate(510,500)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􋚥</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󻚥</text></g>
					body	  <g transform="translate(476,475)"><text class="sym-fill" style="pointer-events:none;font-family:'SuttonSignWritingFill';font-size:30px;fill:white;">􀀚</text><text class="sym-line" style="pointer-events:none;font-family:'SuttonSignWritingLine';font-size:30px;fill:black;">󰀚</text></g>
					body	</svg>
group	apitxt	ApiTxt uses eleven types of element to define an API.
	line	root, group, route, parameter, method, request, response, header, line, code, and body.
	line	
	line	+ Source: [ApiTxt format](../src/apitxt.txt) and [JSON objects](../src/apitxt.json)
	line	+ Documents: [API Blueprint](../doc/apitxt.md) and [Stand Alone HTML](../doc/apitxt.htm)
	line	+ Live Page: [API Interface](../api/apitxt.html) and [JavaScript](../api/apitxt.js)
	route	/apitxt/root	root
		line	Every document should start with a root element.
		line	After the root, the other elements are used to quickly create complex website APIs.
		line	The order of the lines matters and will effect the structure of the JSON objects.
		line	
		line	There are two groups of elements, the frame elements and the detail elements.
		line	The frame elements structure a website api and the detail elements attach to a previous frame element.
		line	
		line	### Frame elements
		line	There are six frame elements: root, group, route, method, request, and response.
		line	The lines are written in a specific order to create an array of JSON objects.
		line	
		line	**route organization**
		line	
		line	An ApiTxt document starts with a root, or an assumed root.
		line	Any route that occur before a group element, will be associated with the root.
		line	Groups are always associated with the root.
		line	Group elements can contain routes.
		line	
		line	```
		line	    root
		line	      | - routes
		line	      | - groups
		line	            | - routes
		line	```
		line	
		line	**route structure**
		line	
		line	A route can be associated with a variety of HTTP methods.
		line	Each method can have several requests and responses.
		line	Any response before a request will assume a generic request.
		line	Any response after a request will be associated with that request.
		line	
		line	```
		line	    route
		line	      | - methods
		line	        | - responses
		line	        | - requests
		line	              | - responses
		line	```
		line	
		line	## Detail elements
		line	There are five detail elements: line, parameter, code, header, and body.  The detail lines attach to a previous frame element if correctly structured.
		line	
		line	**single line elements**
		line	
		line	+ lines for all frame elements
		line	+ parameters for route
		line	+ code for method
		line	+ body for request and response
		line	+ headers for request and response
		line	
		method	GET	Get root definition
			line	Every document should start with a root element.
			line	
			line	**root line**
			line	
			line	root &lt;TAB> name &lt;TAB> title &lt;TAB> host
			line	
			line	+ field 1 - name - uniquely identifies a document
			line	+ field 2 - title - name of the document
			line	+ field 3 - host - website URL
			line	
			line	**root example**
			line	
			line	root &lt;TAB> apitxt &lt;TAB> ApiTxt &lt;TAB> https://signpuddle.com/apitxt
			line	
			line	
			line	**root line relationships**
			line	
			line	```
			line	    root
			line	     | - lines
			line	     | - routes
			line	     | - groups
			line	```
			line	
			line	**root object**
			line	
			line	```json
			line	{
			line	  "root" : field[1],
			line	  "title" : field[2],
			line	  "host" : field[3],
			line	  "lines" : []
			line	}
			line	```
			line	
			request	the root definition
				response	200	text/plain
					body	Every document should start with a root element.
					body	
					body	**root line**
					body	
					body	root<TAB>name<TAB>title<TAB>host
					body	
					body	+ field 1 - name - uniquely identifies a document
					body	+ field 2 - title - name of the document
					body	+ field 3 - host - website URL
					body	
					body	**example**
					body	
					body	root<TAB>apitxt<TAB>ApiTxt<TAB>https://signpuddle.com/apitxt
					body	
					body	
					body	**root line relationships**
					body	
					body	```
					body	    root
					body	     | - lines
					body	     | - routes
					body	     | - groups
					body	```
					body	
					body	**root object**
					body	
					body	```json
					body	{
					body	  "root" : field[1],
					body	  "title" : field[2],
					body	  "host" : field[3],
					body	  "lines" : []
					body	}
					body	```
	route	/apitxt/group	group
		method	GET	Get group definition
			line	The group organizes resources into sections
			line	
			line	**group line**
			line	
			line	group &lt;TAB> name &lt;TAB> description
			line	
			line	+ field 1 - name - the short name used for sections
			line	+ field 2 - description - information about the group
			line	
			line	**group example**
			line	
			line	group &lt;TAB> Section name &lt;TAB> an example section
			line	
			line	**group line relationships**
			line	
			line	```
			line	    group
			line	     | - lines
			line	     | - routes
			line	```
			line	
			line	**group object**
			line	
			line	```json
			line	{
			line	  "group" : field[1],
			line	  "description" : field[2],
			line	  "lines": []
			line	}
			line	```
			line	
			request	the group definition
				response	200	text/plain
					body	The group organizes resources into sections
					body	
					body	**group line**
					body	
					body	group<TAB>name<TAB>description
					body	
					body	+ field 1 - name - the short name used for sections
					body	+ field 2 - description - information about the group
					body	
					body	**group example**
					body	
					body	group<TAB>Section name<TAB>an example section
					body	
					body	**group line relationships**
					body	
					body	```
					body	    group
					body	     | - lines
					body	     | - routes
					body	```
					body	
					body	**group object**
					body	
					body	```json
					body	{
					body	  "group" : field[1],
					body	  "description" : field[2],
					body	  "lines": []
					body	}
					body	```
	route	/apitxt/route	route
		method	GET	Get route definition
			line	The route element allows access to a resource
			line	
			line	**route line**
			line	
			line	route &lt;TAB> URI template &lt;TAB> name &lt;TAB> description
			line	
			line	+ field 1 - URI template - a resource pattern with parameters
			line	+ field 2 - name - the route name must be unique
			line	+ field 3 - description - information about the resource
			line	
			line	**route example**
			line	
			line	route &lt;TAB> /example &lt;TAB> an example route &lt;TAB> a description of the route
			line	
			line	**route line relationships**
			line	
			line	```
			line	    route
			line	     | - lines
			line	     | - parameters
			line	     | - methods
			line	```
			line	
			line	**route object**
			line	
			line	```json
			line	{
			line	  "route" : field[1],
			line	  "name" : field[2],
			line	  "description" : field[3],
			line	  "lines": [],
			line	  "parameters": []
			line	}
			line	```
			line	
			request	the route definition
				response	200	text/plain
					body	The route element allows access to a resource
					body	
					body	**route line**
					body	
					body	route<TAB>URI template<TAB>name<TAB>description
					body	
					body	+ field 1 - URI template - a resource pattern with parameters
					body	+ field 2 - name - the route name must be unique
					body	+ field 3 - description - information about the resource
					body	
					body	**route example**
					body	
					body	route<TAB>/example<TAB>an example route<TAB>a description of the route
					body	
					body	**route line relationships**
					body	
					body	```
					body	    route
					body	     | - lines
					body	     | - parameters
					body	     | - methods
					body	```
					body	
					body	**route object**
					body	
					body	```json
					body	{
					body	  "route" : field[1],
					body	  "name" : field[2],
					body	  "description" : field[3],
					body	  "lines": [],
					body	  "parameters": []
					body	}
					body	```
	route	/apitxt/parameter	parameter
		method	GET	Get parameter definition
			line	The parameter element is applied to the previous route
			line	
			line	**parameter line**
			line	
			line	parameter &lt;TAB> name &lt;TAB> example &lt;TAB> type &lt;TAB> description
			line	
			line	+ field 1 - name - the name of a parameter for a route
			line	+ field 2 - example - an example value for the parameter
			line	+ field 3 - type - the parameter type, such as "string", "number", "boolean", "string, optional", "string, required"
			line	+ field 4 - description - information about the parameter
			line	
			line	**parameter example**
			line	
			line	parameter &lt;TAB> country_code &lt;TAB> US &lt;TAB> string &lt;TAB> the country code of interest
			line	
			line	**parameter line relationships**
			line	
			line	parameter lines are added to a parameters array
			line	
			line	**parameters array**
			line	
			line	```json
			line	{"parameters":
			line	  [
			line	    {
			line	      "name" : " field[1],
			line	      "example" : field[2],
			line	      "type" : field[3],
			line	      "description" : field[4]
			line	    }
			line	  ]
			line	}
			line	```
			line	
			request	the parameter definition
				response	200	text/plain
					body	The parameter element is applied to the previous route
					body	
					body	**parameter line**
					body	
					body	parameter<TAB>name<TAB>example<TAB>type<TAB>description
					body	
					body	+ field 1 - name - the name of a parameter for a route
					body	+ field 2 - example - an example value for the parameter
					body	+ field 3 - type - the parameter type, such as "string", "number", "boolean", "string, optional", "string, required"
					body	+ field 4 - description - information about the parameter
					body	
					body	**parameter example**
					body	
					body	parameter<TAB>country_code<TAB>US<TAB>string<TAB>the country code of interest
					body	
					body	**parameter line relationships**
					body	
					body	parameter lines are added to a parameters array
					body	
					body	**parameters array**
					body	
					body	```json
					body	{"parameters":
					body	  [
					body	    {
					body	      "name" : " field[1],
					body	      "example" : field[2],
					body	      "type" : field[3],
					body	      "description" : field[4]
					body	    }
					body	  ]
					body	}
					body	```
	route	/apitxt/method	method
		method	GET	Get method definition
			line	The method element represents an action that can be performed on a route
			line	
			line	**method line**
			line	
			line	method &lt;TAB> HTTP method &lt;TAB> name &lt;TAB> description
			line	
			line	+ field 1 - HTTP method - the type of action to perform: GET, POST, PUT, DELETE
			line	+ field 2 - name - the name of the action
			line	+ field 3 - description - information about the method
			line	
			line	**method example**
			line	
			line	method &lt;TAB> GET &lt;TAB> Get an example &lt;TAB> This method retrieves an example document
			line	
			line	**method line relationships**
			line	
			line	```
			line	    method
			line	     | - lines
			line	     | - code
			line	     | - requests
			line	     | - responses
			line	```
			line	
			line	**method object**
			line	
			line	```json
			line	{
			line	  "method" : field[1],
			line	  "name" : field[2],
			line	  "description" : field[3],
			line	  "lines" : [],
			line	  "code" : [],
			line	  "dialog" : [
			line	    {
			line	      "request" : {},
			line	      "responses" : []
			line	    }
			line	  ]
			line	}
			line	```
			line	
			request	the method definition
				response	200	text/plain
					body	The method element represents an action that can be performed on a route
					body	
					body	**method line**
					body	
					body	method<TAB>HTTP method<TAB>name<TAB>description
					body	
					body	+ field 1 - HTTP method - the type of action to perform: GET, POST, PUT, DELETE
					body	+ field 2 - name - the name of the action
					body	+ field 3 - description - information about the method
					body	
					body	**method example**
					body	
					body	method<TAB>GET<TAB>Get an example<TAB>This method retrieves an example document
					body	
					body	**method line relationships**
					body	
					body	```
					body	    method
					body	     | - lines
					body	     | - code
					body	     | - requests
					body	     | - responses
					body	```
					body	
					body	**method object**
					body	
					body	```json
					body	{
					body	  "method" : field[1],
					body	  "name" : field[2],
					body	  "description" : field[3],
					body	  "lines" : [],
					body	  "code" : [],
					body	  "dialog" : [
					body	    {
					body	      "request" : {},
					body	      "responses" : []
					body	    }
					body	  ]
					body	}
					body	```
	route	/apitxt/request	request
		method	GET	Get request definition
			line	The request element is associated with a specific method and can be paired with multiple responses.
			line	
			line	**request line**
			line	
			line	request &lt;TAB> name &lt;TAB> type
			line	
			line	+ field 1 - name - uniquely identifies a request
			line	+ field 2 - type - the content type of the request body
			line	
			line	**request example**
			line	
			line	request &lt;TAB> matching text within request body &lt;TAB> plain/text
			line	
			line	**request line relationships**
			line	
			line	```
			line	    request
			line	     | - lines
			line	     | - headers
			line	     | - body
			line	```
			line	
			line	**request object**
			line	
			line	```json
			line	{
			line	  "name" : field[1],
			line	  "type" : field[2],
			line	  "lines" : [],
			line	  "headers" : {},
			line	  "body" : []
			line	}
			line	```
			line	
			request	the request definition
				response	200	text/plain
					body	The request element is associated with a specific method and can be paired with multiple responses.
					body	
					body	**request line**
					body	
					body	request<TAB>name<TAB>type
					body	
					body	+ field 1 - name - uniquely identifies a request
					body	+ field 2 - type - the content type of the request body
					body	
					body	**request example**
					body	
					body	request<TAB>matching text within request body<TAB>plain/text
					body	
					body	**request line relationships**
					body	
					body	```
					body	    request
					body	     | - lines
					body	     | - headers
					body	     | - body
					body	```
					body	
					body	**request object**
					body	
					body	```json
					body	{
					body	  "name" : field[1],
					body	  "type" : field[2],
					body	  "lines" : [],
					body	  "headers" : {},
					body	  "body" : []
					body	}
					body	```
	route	/apitxt/response	response
		method	GET	Get response definition
			line	The response element is associated with a specific request, or associated with a specific method with an assumed generic request.
			line	
			line	**response line**
			line	
			line	response &lt;TAB> status &lt;TAB> type
			line	
			line	+ field 1 - status - an HTTP response code indicating the status of the request
			line	+ field 2 - type - the content type of the response body
			line	
			line	**response example**
			line	
			line	response &lt;TAB> 200 &lt;TAB> plain/text
			line	
			line	**response line relationships**
			line	
			line	```
			line	    response
			line	     | - lines
			line	     | - headers
			line	     | - body
			line	```
			line	
			line	**response object**
			line	
			line	```json
			line	{
			line	  "status" : field[1],
			line	  "type" : field[2],
			line	  "lines" : [],
			line	  "headers" : {},
			line	  "body" : []
			line	}
			line	```
			line	
			request	the response definition
				response	200	text/plain
					body	The response element is associated with a specific request, or associated with a specific method with an assumed generic request.
					body	
					body	**response line**
					body	
					body	response<TAB>status<TAB>type
					body	
					body	+ field 1 - status - an HTTP response code indicating the status of the request
					body	+ field 2 - type - the content type of the response body
					body	
					body	**response example**
					body	
					body	response<TAB>200<TAB>plain/text
					body	
					body	**response line relationships**
					body	
					body	```
					body	    response
					body	     | - lines
					body	     | - headers
					body	     | - body
					body	```
					body	
					body	**response object**
					body	
					body	```json
					body	{
					body	  "status" : field[1],
					body	  "type" : field[2],
					body	  "lines" : [],
					body	  "headers" : {},
					body	  "body" : []
					body	}
					body	```
	route	/apitxt/header	header
		method	GET	Get header definition
			line	The header element is applied to a preceding route
			line	
			line	**header line**
			line	
			line	header &lt;TAB> name &lt;TAB> value
			line	
			line	+ field 1 - name - the header variable name
			line	+ field 2 - value - the header variable value
			line	
			line	**header example**
			line	
			line	header &lt;TAB> X-Powered-By &lt;TAB> ApiTxt
			line	
			line	**header object**
			line	
			line	```json
			line	{ field[1] : field[2] }
			line	```
			line	
			request	the header definition
				response	200	text/plain
					body	The header element is applied to a preceding request or response
					body	
					body	**header line**
					body	
					body	header<TAB>name<TAB>value
					body	
					body	+ field 1 - name - the header variable name
					body	+ field 2 - value - the header variable value
					body	
					body	**header example**
					body	
					body	header<TAB>X-Powered-By<TAB>ApiTxt
					body	
					body	**header object**
					body	
					body	```json
					body	{ field[1] : field[2] }
					body	```
	route	/apitxt/body	body
		method	GET	Get body definition
			line	The body element adds contents to a preceding request or response.
			line	
			line	The text of the body is everything after the string "body &lt;TAB>".
			request	the body definition
				response	200	text/plain
					body	The body element adds contents to a preceding request or response.
					body	
					body	The text of the body is everything after the string "body <tab>"
	route	/apitxt/line	line
		method	GET	Get line definition
			line	The line element adds additional text to frame elements.
			line	
			line	For the root, group, route, method, request, and response, the lines add details to an element.
			line	
			line	The text of the line is everything after the string "line &lt;TAB>".
			request	the line definition
				response	200	text/plain
					body	The line element adds additional text to frame elements.
					body	
					body	For the root, group, route, method, request, and response, the lines add details to an element.
					body	
					body	The text of the line is everything after the string "line <tab>".
	route	/apitxt/code	code
		method	GET	Get code definition
			line	The code element adds functionality to the method element.
			line	
			line	The code element contains programming text.  ApiTxt comes integrated with the PHP project the Slim Framework v2.  The conversion to working PHP adds boilerplate details for routes and method, with named parameters and query parameters available as functional variables.
			line	
			line	The text of the code is everything after the string "code &lt;TAB>".
			request	the code definition
				response	200	text/plain
					body	The code element adds functionality to the method element.
					body	
					body	The code element contains programming text.  ApiTxt comes integrated with the PHP project the Slim Framework v2.  The conversion to working PHP adds boilerplate details for routes and method, with named parameters and query parameters available as functional variables.
					body	
					body	The text of the code is everything after the string "code <tab>".