[
{
"lines": [
"> v3.0.0"
],
"host": "https://signpuddle.com/server",
"meta": "Generated from ApiTxt format (output/fsw.txt) using txt2json.py",
"root": "fsw",
"title": "Formal SignWriting in ASCII (FSW)"
},
{
"lines": [
"+ Source: [ApiTxt format](../src/fsw.txt) and [JSON objects](../src/fsw.json)",
"+ Documents: [API Blueprint](../doc/fsw.md) and [Stand Alone HTML](../doc/fsw.htm)",
"+ Live Page: [API Interface](../api/fsw.html) and [JavaScript](../api/fsw.js)"
],
"group": "FSW",
"description": "Resources related to Formal SignWriting in ASCII (FSW)"
},
{
"route": "/fsw{?text,style}",
"name": "FSW Word",
"parameters": [
{
"description": "The name of sign",
"type": "string",
"name": "text",
"example": "AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520"
},
{
"description": "Flag to include styling string",
"type": "boolean,optional",
"name": "style",
"example": "true"
}
]
},
{
"code": [
"$fsw = SignWriting\\fsw($text,$style);",
"$searchTime = searchtime($timein);",
"header(\"Search-Time: \" . $searchTime);",
"echo $fsw;"
],
"method": "GET",
"dialog": [
{
"request": {
"name": "one Formal SignWriting in ASCII string"
},
"responses": [
{
"status": 200,
"body": [
"AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520"
],
"type": "text/plain;charset=utf-8"
}
]
}
],
"name": "First FSW string"
},
{
"route": "/fsw/all{?text,style}",
"name": "FSW Text",
"parameters": [
{
"description": "The name of sign",
"type": "string",
"name": "text",
"example": "AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520"
},
{
"description": "Flag to include styling string",
"type": "number",
"name": "style",
"example": "1"
}
]
},
{
"code": [
"$fsw = SignWriting\\fswAll($text,$style);",
"$searchTime = searchtime($timein);",
"header(\"Search-Time: \" . $searchTime);",
"echo $fsw;"
],
"method": "GET",
"dialog": [
{
"request": {
"name": "many Formal SignWriting in ASCII string"
},
"responses": [
{
"status": 200,
"body": [
"AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520"
],
"type": "text/plain;charset=utf-8"
}
]
}
],
"name": "All FSW strings"
},
{
"route": "/fsw/swu{?text}",
"name": "FSW to SWU",
"parameters": [
{
"description": "The name of sign",
"type": "string",
"name": "text",
"example": "AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520"
}
]
},
{
"code": [
"$swu = SignWriting\\fsw2swu($text);",
"$searchTime = searchtime($timein);",
"header(\"Search-Time: \" . $searchTime);",
"echo $swu;"
],
"method": "GET",
"dialog": [
{
"request": {
"lines": [
"transformation from ASCII to Unicode characters."
],
"name": "SWU conversion of FSW string"
},
"responses": [
{
"status": 200,
"lines": [
"requires font SuttonSignWritingOneD"
],
"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"
],
"type": "text/plain;charset=utf-8"
}
]
}
],
"name": "Text with FSW strings"
},
{
"route": "/fsw/svg/{text}",
"lines": [
"Create a stand-alone SVG image using Formal SignWriting in ASCII (FSW)"
],
"name": "SVG image",
"parameters": [
{
"description": "The name of sign",
"type": "string",
"name": "text",
"example": "AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520"
}
]
},
{
"code": [
"$req = $app->request();",
"if ($req->get('throwStatus')=='500') {haltNoDatabase();}",
"$svg = SignWriting\\svg($text);",
"$searchTime = searchtime($timein);",
"header(\"Search-Time: \" . $searchTime);",
"echo $svg;"
],
"method": "GET",
"dialog": [
{
"request": {
"name": "collection text"
},
"responses": [
{
"status": 200,
"body": [
""
],
"type": "image/svg+xml;charset=utf-8"
}
]
}
],
"name": "Retrieve stand alone SVG image"
},
{
"route": "/fsw/svg/font/{text}",
"lines": [
"Create an SVG with font using Formal SignWriting in ASCII (FSW)"
],
"name": "SVG with font",
"parameters": [
{
"description": "The name of sign",
"type": "string",
"name": "text",
"example": "AS20310S26b02S33100M521x547S33100482x483S20310506x500S26b02503x520"
}
]
},
{
"code": [
"$req = $app->request();",
"if ($req->get('throwStatus')=='500') {haltNoDatabase();}",
"$svg = SignWriting\\svg($text,true);",
"$searchTime = searchtime($timein);",
"header(\"Search-Time: \" . $searchTime);",
"echo $svg;"
],
"method": "GET",
"dialog": [
{
"request": {
"name": "collection text"
},
"responses": [
{
"status": 200,
"body": [
""
],
"type": "image/svg+xml;charset=utf-8"
}
]
}
],
"name": "Retrieve SVG with font"
}
]