Template:Infobox Voice Assistant: Difference between revisions

From Voice Technology Wiki
Jump to navigation Jump to search
m (Test)
m (Small improvements.)
Line 14: Line 14:
|-
|-
! URL
! URL
| {{{url-Param|}}}
| {{{Url|}}}
|-
|-
{{#if:{{{license-Param|
{{#if:{{{license-Param|
! License
! License
| {{{license-Param|}}}
| {{{license|}}}
|-
|-
}}} }}
}}} }}
! Operating System
! Operating System
| {{{os-Param|}}}
| {{{SupportedOS|}}}
|-
|-
! Programming Language
! Programming Language
| {{{codelang-Param|}}}
| {{{CodeLanguage|}}}
|-
|-
! Supported Languages
! Supported Languages
| {{{supplang-Param|}}}
| {{{SupportedLanguages|}}}
|-
|-
! Internetaccess required
! Internetaccess required
| {{{inetreq-Param|}}}
| {{{InternetRequired|}}}
|-
|-
! Default STT Engine
! Default STT Engine
| {{{defstt-Param|}}}
| {{{DefaultSTT|}}}
|-
|-
! Default Wakeword
! Default Wakeword
| {{{defwakeword-Param|}}}
| {{{WakeWord|}}}
|-
|-
! Default TTS Engine
! Default TTS Engine
| {{{deftts-Param|}}}
| {{{DefaultTTS|}}}
|-
|-
! Latest Version
! Latest Version
| {{{version-Param|}}}
| {{{LatestVersion|}}}
|-
|-
! Latest Update
! Latest Update
| {{{lastupdate-Param|}}}
| {{{LatestReleaseDate|}}}
|}
|}
</onlyinclude>
</onlyinclude>
Line 52: Line 52:
<templatedata>
<templatedata>
{
{
    "description": "",
"description": "Infobox template for all available (open) voice assistants.",
    "params": {
"params": {
        "name-Param": {
"Name": {
            "label": "Name of voice assistant",
"description": "Name of voice assistant, project or building company.",
            "description": "Project or Company name",
"example": "Cool Voice Assistant",
            "type": "string"
"type": "string",
        },
"required": true
        "url-Param": {
},
            "label": "Domain for further info on Voice Assistant",
"Url": {
            "description": "",
"description": "Webaddress for further information on this voice assistant.",
            "type": "string"
"example": "https://www.CoolVoiceAssistant.local",
        },
"type": "url"
        "license-Param": {
},
            "label": "License for Voice Assistant",
"License": {
            "description": "",
"description": "License this voice assistant is build / delivered with.",
            "type": "string"
"type": "string"
        },
},
        "os-Param": {
"SupportedLanguages": {
            "label": "Supported Operating Systems",
"description": "Languages supported by this voice assistant (multi for several languages).",
            "description": "",
"type": "string",
            "type": "string"
"default": "multi"
        },
},
        "codelang-Param": {
"CodeLanguage": {
            "label": "Code development language",
"description": "Developped in which code language",
            "description": "Python, Perl, PHP, ...",
"type": "string",
            "type": "string"
"default": "Python, Perl, PHP, ..."
        },
},
        "supplang-Param": {
"InternetRequired": {
            "label": "Voice assistant for a specific or multi language",
"description": "Is Internet access required for this voice assistant to work properly",
            "description": "multi for several languages",
"type": "boolean",
            "type": "string"
"required": true
        },
},
        "inetreq-Param": {
"DefaultSTT": {
            "label": "Is Internet access required to work properly",
"description": "Default engine for speech recognition.",
            "description": "",
"type": "string",
            "type": "string"
"default": "Cloud, Deepspeech, Kaldi, ..."
        },
},
        "defstt-Param": {
"DefaultTTS": {
            "label": "Default engine for speech recognition",
"description": "Default engine for speech generation (TTS)",
            "description": "",
"example": "Cloud, Coqui TTS, ...",
            "type": "string"
"type": "string"
        },
},
        "defwakeword-Param": {
"SupportedOS": {
            "label": "Default Wakeword to activate Voice assistant",
"description": "Supported Operating Systems",
            "description": "",
"type": "string",
            "type": "string"
"default": "Raspian, Ubuntu, Mac OS X, Windows",
        },
"required": true
        "deftts-Param": {
},
            "label": "Default engine for speech generation",
"WakeWord": {
            "description": "",
"description": "Default Wakeword to activate Voice assistant.",
            "type": "string"
"type": "string",
        },
"default": "Hey Mycroft.",
        "version-Param": {
"required": true
            "label": "Latest public available version",
},
            "description": "",
"LatestVersion": {
            "type": "string"
"description": "Latest public stable available version",
        },
"type": "string"
        "lastupdate-Param": {
},
            "label": "Last public software update",
"LatestReleaseDate": {
            "description": "",
"description": "Release date of latest stable version.",
            "type": "string"
"type": "date"
        }
}
    }
},
"format": "block",
"paramOrder": [
"Name",
"Url",
"License",
"SupportedOS",
"CodeLanguage",
"SupportedLanguages",
"InternetRequired",
"DefaultSTT",
"DefaultTTS",
"WakeWord",
"LatestVersion",
"LatestReleaseDate"
]
}
}
</templatedata>
</templatedata>

Revision as of 18:32, 21 December 2021

{{Infobox Voice Assistant
|VoiceAssist-URL-Param=
|VoiceAssist-License=Wiki Syntax example
|license-Param=a
}}


Infobox Voice Assistant
URL
Operating System
Programming Language
Supported Languages
Internetaccess required
Default STT Engine
Default Wakeword
Default TTS Engine
Latest Version
Latest Update


Infobox template for all available (open) voice assistants.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
NameName

Name of voice assistant, project or building company.

Example
Cool Voice Assistant
Stringrequired
UrlUrl

Webaddress for further information on this voice assistant.

Example
https://www.CoolVoiceAssistant.local
URLoptional
LicenseLicense

License this voice assistant is build / delivered with.

Stringoptional
SupportedOSSupportedOS

Supported Operating Systems

Default
Raspian, Ubuntu, Mac OS X, Windows
Stringrequired
CodeLanguageCodeLanguage

Developped in which code language

Default
Python, Perl, PHP, ...
Stringoptional
SupportedLanguagesSupportedLanguages

Languages supported by this voice assistant (multi for several languages).

Default
multi
Stringoptional
InternetRequiredInternetRequired

Is Internet access required for this voice assistant to work properly

Booleanrequired
DefaultSTTDefaultSTT

Default engine for speech recognition.

Default
Cloud, Deepspeech, Kaldi, ...
Stringoptional
DefaultTTSDefaultTTS

Default engine for speech generation (TTS)

Example
Cloud, Coqui TTS, ...
Stringoptional
WakeWordWakeWord

Default Wakeword to activate Voice assistant.

Default
Hey Mycroft.
Stringrequired
LatestVersionLatestVersion

Latest public stable available version

Stringoptional
LatestReleaseDateLatestReleaseDate

Release date of latest stable version.

Dateoptional