WPS加载项在线模式发布流程

Lv.1 新人创作者
发布
准备好能够访问的服务器,本文以https://www.xx.cn/wps_jsaddons/bu/为例。
先检查项目文件package.json中的addonType是否已配置,通常已配置,可忽略该步骤
执行wpsjs publish发布
按要求输入发布地址,切记:输入完整的地址,包括协议https://和最后的/。本文输入https://www.xx.cn/wps_jsaddons/bu/
选择发布模式,本文选在线模式
选择是否多用户使用:本文选是
| ❗ | 第3步务必输入完整地址,不然无法加载加载项。 比如:www.xx.cn/wps_jsaddons/bu/是无效的。 |
过程如下图,按实际需求输入即可:
最后会提示如何发布到服务器:
==>> 1.生成发布文件成功。请确保将目录D:\xxx\wps-addon-build下的文件部署到https://www.xx.cn/wps_jsaddons/bu/
请用浏览器访问https://www.xx.cn/wps_jsaddons/bu/ribbon.xml来验证部署是否成功,成功打开后是以'<customUI...'开头的文本
==>> 2.请将D:\xxx\wps-addon-publish\publish.html分发给使用者,强烈建议同样将其部署到服务器...用户只需要按提示将项目中的wps-addon-build文件夹发布到指定的服务器目录,而生成的wps-addon-publish\publish.html可根据自己的需求发布到服务器(以后通过URL访问)或者直接将文件发给其他人(以后直接双击通过浏览器打开)即可。
使用
将wps-addon-publish\publish.html文件打开(可直接打开,或上传服务器后通过URL访问),本文中发布到了服务器,输入网址后将会看到如下界面(可能需要刷新才会显示):
请确保状态为正常,然后点击安装按钮提示成功即可。
| ❗ | 如果服务器地址不完整,状态就会显示为无效。 |
| 💡 | 有验证和授权提示按需选择是否允许即可。 |
安装完成后需要重新打开WPS客户端,新配置的加载项需要用户允许,允许后稍等一下(半分钟左右)就会加载。
如果用户使用过wpsjs开发包,wps会以为你是开发者,加载项会出现“打开JS调试器”,有两种方法可以取消:
重新安装WPS
删除本地配置文件%appdata\kingsoft\wps\jsaddons\publish.xml中的enable字段内容即可。
另一种方式
使用publish发布的内容如果有对话框和窗格,直接部署到服务器无效,估计是需要vue之类的服务环境,如果不想折腾可以使用build命令打包。
保留之前使用wpsjs publish命令得到的publish.html文件
| 💡 | 也可不是使用publish.html,直接配置%appdata\kingsoft\wps\jsaddons\publish.xml文件,但感觉太麻烦,不如publish.html省事 |
使用wpsjs bulid打包,选离线模式
将生成的.7z文件部署到服务器,.7z文件内是一个文件夹,文件夹以加载项名称_版本号命名,之后会用到该版本号(也就是项目文件package.json中的version字段)
修改第1步保留的publish.html文件,修改方法如下(根据实际情况填写,但注意url和version别填错了),同时也可以将该文件发布到服务器
function LoadPublishAddons() {
var addonList = document.getElementById("addonList");
// 只修改curList内容即可
var curList = [
{
"name":"加载项名称",
"addonType":"et",
"online":"false",
"multiUser":"false",
"url":"https://实际域名/实际路径/实际文件名.7z",
"version":"1.0.0" // 版本号要与.7z文件里的对应
}
];
// ...
}直接打开或者通过URL访问publish.html并安装,加载页面过程中会提示下载,应该是还需要调整publish.html,懒得改了就这样。。。
打开或重启WPS客户端,允许加载即可
如果打算手动配置%appdata\kingsoft\wps\jsaddons\publish.xml文件可参考:
<?xml version="1.0" encoding="UTF-8"?>
<jsplugins>
<jsplugin url="https://www.xx.cn/yy/zz.7z" debug="" version="1.0.0" enable="enable_dev" install="https://www.xx.cn" versionUrl="" name="zz" type="et"/>
</jsplugins>任务窗格未测试,自定义函数与对话框没问题。