OpenSearch描述文档XML怎么写

夜婷大大_3414

夜婷大大_3414

2026-01-02

391人浏览

原创

OpenSearch 描述文档是声明 Web 搜索服务的 XML 文件,需以 UTF-8 编码,根元素为 ,含 ShortName、Description、Url(含 {searchTerms} 占位符)等必需字段,并通过 HTML 标签声明以便浏览器发现。

opensearch描述文档xml怎么写

OpenSearch 描述文档(OpenSearch Description Document)是一个 XML 文件,用于向客户端(如浏览器、搜索工具)声明一个可被发现和使用的搜索服务。它不是 OpenSearch(AWS 或开源搜索引擎)的配置文件,而是 Web 搜索插件标准(由 Mozilla 和 Microsoft 等早期推动)的规范。 以下是编写 OpenSearch 描述文档 XML 的核心要点和示例:

基本结构与必需字段

XML 必须以 UTF-8 编码,根元素为 ,并声明命名空间:
xmlns="http://a9.com/-/spec/opensearch/1.1/"
必需子元素包括:

  • ShortName:≤16 字符的简短名称(如 “MySite Search”)
  • Description:≤1024 字符的说明(如 “Search articles on MySite”)
  • Url:含 type 和 template 属性的搜索端点,rel="search" 表示默认搜索;支持 {searchTerms} 占位符

Url 元素写法与参数支持

是关键部分,常见写法如下:

  • GET 请求(最常用):
  • 支持多个参数(用 & 连接):
    template="https://example.com/s?k={searchTerms}&lang=zh&format=json"
  • 支持可选占位符:{searchTerms}(必填)、{language}、{inputEncoding}、{outputEncoding}
  • 若需 POST 请求,设 method="post",但多数浏览器仅支持 GET

可选但推荐的增强字段

提升兼容性与体验,建议补充:

使用华数设计生成高保真HTML原型、演示文稿、动画和设计评审
使用华数设计生成高保真HTML原型、演示文稿、动画和设计评审

使用经过文档化的设计技能,从真实的品牌或项目背景中生成HTML原生原型、幻灯片、动态演示、可视化图表和评审流程。

下载
  • Image:16×16 或 64×64 PNG 或 ICO 图标(用于地址栏显示)
    https://example.com/favicon.ico
  • InputEncoding 和 OutputEncoding:明确声明编码(通常为 UTF-8)
  • Tags:空格分隔的关键词(如 search site example)
  • Developer、Contact、Attribution:归属信息(非强制)

完整示例(可直接保存为 opensearch.xml)

<?xml version="1.0" encoding="UTF-8"?><opensearchdescription xmlns="http://a9.com/-/spec/opensearch/1.1/"><shortname>MyBlog Search</shortname><description>Search posts and tutorials on MyBlog</description><tags>blog tutorial dev</tags><contact>admin@myblog.com</contact><url type="text/html" method="get" template="https://myblog.com/search?q={searchTerms}&src=os"></url><inputencoding>UTF-8</inputencoding><outputencoding>UTF-8</outputencoding><image height="16" width="16" type="image/x-icon">
    https://myblog.com/favicon.ico
  </image></opensearchdescription>

注意:该 XML 需通过 HTTP 可公开访问(如 https://example.com/opensearch.xml),并在网站 HTML 的 中用 声明,浏览器才能自动发现。 不复杂但容易忽略编码声明和 Url template 中的 {searchTerms} 占位符格式。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

2235

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

3602

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

1196

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

4139

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1809

3

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.06.27

1211

7

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.01

4904

5

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2024.08.01

6357

7

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

2024.11.28

2562

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 234人学习