octavenz / reoako
Reoako的一个模块。
Requires
- guzzlehttp/guzzle: ^7
- silverstripe/framework: ^5.0
Requires (Dev)
- phpunit/phpunit: ^5.7
- squizlabs/php_codesniffer: ^3.0
- 1.0.1
- 1.0.0
- 0.3.0
- 0.2.3
- 0.2.2
- 0.2.2.0-alpha
- 0.2.1
- 0.2.0
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
- dev-feature/silverstripe-5-support
- dev-feat/bump-version-0.2.3
- dev-fix/capitalization
- dev-silverstripe5
- dev-feature/add-uniqueness-ID-to-FE-JS
- dev-feature/php8.2-cms-support
- dev-fix/whitespace-append
- dev-testing/setup
- dev-feature/reoako-frontend-upgrade
- dev-fix/php-errors
- dev-feature/springloader-feedback
- dev-fix/silverstripe48-tinymce
- dev-master / 1.x-dev
This package is auto-updated.
Last update: 2024-09-05 05:31:12 UTC
README
Reoako银Stripe CMS包帮助内容管理员在我国正确使用我们的国家语言。正确使用毛利语,在正确的语境中,并通过单词定义和发音支持您的读者。
要求
注意:请使用1.x.x标签以支持Silverstripe 5
- Silverstripe 4.X
- Composer
- Reoako API密钥 - 在此注册以获取更多信息
测试于
- CWP配方2.8
- Silverstripe 4.8
- PHP 7.4, 8.0
组件
Reoako银Stripe包由4个组件组成。
TinyMCE插件
允许内容编辑员通过TinyMCE在富字段中搜索和插入翻译。
Reoako PHP客户端
用于TinyMCE插件通过认证并向Reoako API发送请求进行翻译
Reoako Silverstripe设置标签(可选)
允许网站管理员通过设置标签设置API密钥。
如果没有应用此扩展,您需要通过yml或.env设置API密钥 - 请参阅以下内容
Reoako前端扩展(可选)
将Reoako的javascript和css包注入所有前端视图。
如果没有应用此扩展,您需要通过自己的主题构建过程包含Reaoko前端包
https://npmjs.net.cn/package/@octavenz/reoako
安装
-
$ composer require octavenz/reoako:0.3.0
-
开发构建和刷新
扩展和配置
根据您的设置,您可能需要应用一些扩展
要应用扩展,在您的代码库中创建一个config/reoako.yml文件,并将以下示例复制到其中。
添加扩展后,您需要运行开发构建
必需的扩展
短代码扩展
添加短代码扩展,以便在内容字段中使用Reoako短代码
SilverStripe\CMS\Model\SiteTree:
extensions:
- Octavenz\Reoako\Extensions\ReoakoShortCodeExtension
Tinymce扩展
将Reoako Tinymce插件添加到富字段
SilverStripe\Admin\LeftAndMain:
extensions:
- Octavenz\Reoako\Extensions\ReoakoTinymceExtension
Tinymce CSS注入
向TinyMCE编辑器iframe添加CSS,以允许突出显示Reoako标签
SilverStripe\Forms\HTMLEditor\TinyMCEConfig:
editor_css:
- "octavenz/reoako:dist/css/editor.css"
可选扩展
网站配置
在网站配置中添加标签和字段,允许管理员通过设置标签设置Reoako API密钥
SilverStripe\SiteConfig\SiteConfig:
extensions:
- Octavenz\Reoako\Extensions\ReoakoSiteConfig
Reoako前端扩展
将所需的Reoako前端javascript和css注入所有前端页面
此扩展要求您还应用ReoakoSiteConfig扩展。如果您正在为前端编译自己的js/css包,则不应使用此扩展,而应在构建管道中导入Reoako css和javascript - 请参阅https://npmjs.net.cn/package/@octavenz/reoako
SilverStripe\CMS\Model\SiteTree:
extensions:
- Octavenz\Reoako\Extensions\ReoakoFrontendExtension
设置您的API密钥
需要Reoako API密钥
通过以下方法之一设置
.env
在您的.env文件或通过环境变量中设置您的API密钥
SS_REOAKO_API_KEY = <KEY>
设置面板
导航至:/admin/settings/#Root_Reoako
在字段中设置您的API密钥。
YML
通过配置中的yml设置您的密钥
Octavenz\Reoako\Client\ReokakoClient:
api_key: <KEY>
使用TinyMCE插件
当TinyMCE中的Reoako插件启用时,您会注意到一个新按钮。
当文本被选中时,您可以按Reoako按钮来执行选中单词的搜索。
按下Reoako按钮时如果没有选择文本,将会提示您输入要搜索的单词。
当您找到想要插入的单词时,单击其标题将Reoako短代码插入到编辑器中。
待办事项
- 字符输入时的Ajax搜索
- 子站支持
- Bitbucket管道测试
- SS4/CWP测试