MarkLogic

Sublime插件用于MarkLogic XQuery

详细信息

版本 1.2.0
主页 github.com
问题 github.com
修改 8年前
最近看到 2小时前
首次看到 10年前

安装

总计 2K
Win 972
Mac 572
Linux 234

	8月6日	8月5日	8月4日	8月3日	8月2日	8月1日	7月31日	7月30日	7月29日	7月28日	7月27日	7月26日	7月25日	7月24日	7月23日	7月22日	7月21日	7月20日	7月19日	7月18日	7月17日	7月16日	7月15日	7月14日	7月13日	7月12日	7月11日	7月10日	7月9日	7月8日	7月7日	7月6日	7月5日	7月4日	7月3日	7月2日	7月1日	6月30日	6月29日	6月28日	6月27日	6月26日	6月25日	6月24日	6月23日
Windows	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Mac	1	1	0	0	0	0	0	0	1	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Linux	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0

README

源代码: raw.githubusercontent.com

此项目已归档

请使用Visual Studio Code和https://github.com/marklogic-community/mlxprs。

MarkLogic Sublime插件

关于

Sublime Text的MarkLogic XQuery功能丰富的软件包。

功能

MarkLogic xquery扩展支持“1.0-ml”
为MarkLogic内置函数提供语法高亮显示
代码补全 - MarkLogic内置函数的代码补全
XQuery Lint - 检查您的XQuery文件中的错误
在服务器上运行 - 在MarkLogic服务器上运行您的XQuery文件
打开MarkLogic API文档 - 在光标下的函数
搜索MarkLogic在线文档 - 在光标下的单词
Tab片段 以简化常见模式

代码补全

该功能默认启用。只需键入MarkLogic函数的名称，然后按Tab键以完成。将插入包含参数列表的完整函数。按下Tab键可以切换到不同参数。

XQuery Lint

此功能通过在启用静态检查选项的MarkLogic服务器上运行您的XQuery代码来进行语法检查。您可以配置此Lint在加载、保存和编辑时运行。仅适用于Sublime Text 3的编辑检查。

lint设置位于MarkLogic.sublime-settings文件中

// LINT settings
"lint": {
    // Automatically lint on edit (Sublime Text 3 only).
    "lint_on_edit": false,

    // Configurable duration before re-linting.
    "lint_on_edit_timeout": 1,

    // Automatically lint when a file is loaded.
    "lint_on_load": false,

    // Automatically lint when a file is saved.
    "lint_on_save": false,

    // Highlight errors when selected.
    "highlight_selected_regions": true,

    // scroll to reveal any errors found
    "scroll_to_error": false
}

配置要通信的MarkLogic服务器

通过设置

您可以通过MarkLogic.sublime-settings文件指定MarkLogic服务器。

通过Roxy

或者，如果您正在使用Roxy部署程序，服务器设置将从您的Roxy配置文件中自动读取。

// settings for Xcc connection
"xcc": {
    // timeout in seconds for xcc connections
    // can be decimal numbers ex: "1.5"
    "timeout": "1",

    // Use Settings from Roxy's properties files
    // If this is not a Roxy project then the setttings above will be used
    "use_roxy_settings": true,

    // The roxy environment configuration to use
    // Valid choices are usually [local, dev, prod] but may vary
    "roxy_environment": "local",

    // MarkLogic hostname
    "ml_host": "localhost",

    // Xcc port to communicate with for running queries
    "xcc_port": "8041",

    // The content database to use when evaluating queries
    "content_database": "Documents",

    // The modules database to use when evaluating queries
    "modules_database": "Modules",

    // user name to use when authenticating to xcc
    "user": "admin",

    // password name to use when authenticating to xcc
    "password": "admin",

    // Whether or not to use https when communicating with Xcc
    "use_https": false,

    // Local Paths to search for your xquery modules
    "search_paths": [],

    // xquery output options that you want applied when running your query
    // see: http://docs.marklogic.com/guide/xquery/langoverview#id_71572
    "output_options": [
        "indent=yes",
        "indent-untyped=yes"
    ]
}

通过文件夹结构中的配置文件

现在您可以在项目目录中创建一个名为 .ml-sublime-options 的文件。这对于需要指定连接选项的 Roxy 之外的项目非常有用。文件如下所示

{
    // settings for Xcc connection
    "xcc": {
        // timeout in seconds for xcc connections
        // can be decimal numbers ex: "1.5"
        "timeout": "1",

        // MarkLogic hostname
        "ml_host": "localhost",

        // Xcc port to communicate with for running queries
        "xcc_port": "8041",

        // The content database to use when evaluating queries
        "content_database": "Documents",

        // The modules database to use when evaluating queries
        "modules_database": "Modules",

        // user name to use when authenticating to xcc
        "user": "admin",

        // password name to use when authenticating to xcc
        "password": "admin",

        // Whether or not to use https when communicating with Xcc
        "use_https": false,

        // Local Paths to search for your xquery modules
        "search_paths": [],

        // xquery output options that you want applied when running your query
        // see: http://docs.marklogic.com/guide/xquery/langoverview#id_71572
        "output_options": [
            "indent=yes",
            "indent-untyped=yes"
        ]
    }
}

通过命令更改选项

有少量命令可供您选择，以简化数据库切换

设置内容数据库

打开命令面板，找到“MarkLogic：设置 Xcc 内容数据库”

此命令将列出所有可用数据库。选择一个，并将其设置为 Xcc 连接的内容数据库。

设置模块数据库

打开命令面板，找到“MarkLogic：设置 Xcc 模块数据库”

此命令将列出所有可用数据库。选择一个，并将其设置为 Xcc 连接的模块数据库。

在保存时启用 Lint

打开命令面板，找到“MarkLogic：在保存时切换 Lint”

此命令将列出以下两个选项：* 保存时 Lint：开 * 保存时 Lint：关

选择其中一个来设置值

在服务器上运行

通过“MarkLogic：运行文件”命令或按 Ctrl+Alt+r 在 MarkLogic 服务器上运行当前文件。

打开 MarkLogic API 文档

您可以轻松地打开一个浏览器窗口查看 MarkLogic 函数的文档。

当文本被选中或光标在代码中的函数名时，请按平台正确的按键组合

Mac: Command + '
Linux: Ctrl + '
Windows: Ctrl + '

搜索 MarkLogic 在线文档

您可以通过选择当前选中的文本或光标下的字词，轻松搜索 MarkLogic 在线文档。

当文本被选中或光标在字词上时，请按平台正确的按键组合

Mac: Command + Shift + '
Linux: Ctrl + Shift + '
Windows: Ctrl + Shift + '

Tab 代码片段

Tab 代码片段可以帮助您更快地编写代码。通过键入触发词后跟 Tab 来激活它们。

触发词：attribute

插入构造的属性 “xquery attribute name() { () }

##### Trigger: element
Inserts an inline constructed element
```xquery
element name() { () }

触发词：element

插入构造的元素 ”xquery element name() { () }

##### Trigger: fun
Inserts a function declaration with the correct namespace prefix already filled out
```xquery
declare function local:name()
{
    (: code goes here :)
};

触发词：if

插入 if-then-else 语句 “xquery if (expression) then () else ()

##### Trigger: ns
Inserts a namespace declaration
```xquery
declare namespace ns = "http://namespace-uri";

触发词：switch

插入 switch 语句 (xquery 3.0) ”xquery switch (expression) case expression return expression default return expression

##### Trigger: type
Inserts a typeswitch statement
```xquery
typeswitch(expression)
    case expression return
        expression
    default return
        expression

触发词：variable

插入变量声明 “xquery declare variable $x := ();

##### Trigger: log
Inserts a stubbed xdmp:log() call
```xquery
xdmp:log()

xqdoc

插入模板化的 xqdoc 注释

按 Ctrl + Alt + d

(:~
 : Function description
 :
 : @param $function-param - description of param
 : @return - description of return
 :)

使用 Package Control 安装

使用 Package Control 来安装 MarkLogic 插件。

Package Control 将在添加新功能时保持您的插件最新。

要使用 Package Control 进行安装，请执行以下操作

在 Sublime Text 中，通过命令面板输入 install。选择 Package Control：安装插件。当插件列表出现时，选择 MarkLogic。

使用 Git 手动安装

确保您遵循 Sublime 正确版本的说明。

Sublime Text 3 的说明

Mac

> git clone https://github.com/paxtonhare/MarkLogic-Sublime.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/MarkLogic

Linux

> git clone https://github.com/paxtonhare/MarkLogic-Sublime.git ~/.config/sublime-text-3/Packages/MarkLogic

Windows

> git clone https://github.com/paxtonhare/MarkLogic-Sublime.git "%APPDATA%/Sublime Text 3/Packages/MarkLogic"

Sublime Text 2 的说明

Mac

> git clone https://github.com/paxtonhare/MarkLogic-Sublime.git ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/MarkLogic

Linux

> git clone https://github.com/paxtonhare/MarkLogic-Sublime.git ~/.config/sublime-text-2/Packages/MarkLogic

Windows

> git clone https://github.com/paxtonhare/MarkLogic-Sublime.git "%APPDATA%/Sublime Text 2/Packages/MarkLogic"