為我的命令建立提示

為我的命令建立提示

我正在創建一個.sty文件,我希望它對用戶友好。有什麼方法可以為我自己的命令建立提示,就像我在 Kile 中看到的標準 LaTeX 命令一樣?

基爾語的暗示

我想要一個看起來像這樣的命令

\newcommand{\mycommand}[1]{#1}

當我開始打字時\myc,它會告訴我

\mycommand{text}

可以.sty這樣做,以便它可以在任何編輯器中顯示,或者這些提示是每個編輯器的某種特殊設定嗎?

答案1

正如評論中所說,這取決於編輯。在 Kile 中(我假設你在評論中使用這個編輯器)你可以建立一個自己的.cwl檔案;看編寫自己的完成文件在凱爾的手冊中。

對於您的命令,該文件將僅包含該行

\mycommand{text}

也許有評論。

# macros from mypkg.sty
\mycommand{text}

TeXstudio手冊中有一些關於CWL格式的資訊:4.13 cwl格式說明

是否可以在 .sty 中完成,以便它可以在任何編輯器中顯示,或者這些提示是每個編輯器的某種特殊設定嗎?

如前所述,這取決於編輯器(有些編輯器理解 CWL 格式),並且您無法在文件中定義它.sty。但是,如果您發布包,則可以新增符合的.cwl檔案。在這種情況下,使用者必須手動安裝它(取決於他的編輯器在哪裡查找此類文件),或者您可以建議將這些文件包含在編輯器包中。在這種情況下,您必須聯絡不同編輯器的開發人員。

答案2

Kile 可讓您以互動方式添加這些內容。但是,該介面的工作效果不如以前。事實上,Kile 不再能夠.cwl在我的機器上找到它自己的預設檔案。

在配置對話框的頂部LaTeX > General提供了一個標記為 的按鈕。Configure...Configure LaTeX environments and commands

如果您按一下此按鈕,您將看到一個包含兩個標籤的對話方塊:一個用於環境,一個用於命令。這些按功能分組,例如MathsLists。如果按一下某個群組,則可以使用Add對話方塊底部的按鈕新增其他環境/命令。但是,您不能再新增群組(至少我不能)。

截圖:環境

這是一個命令:

截圖:命令

此介面有許多令人沮喪的功能:無法新增群組、無法指定多個可選參數和多個強制參數、無法指定需要非標準語法的巨集等。

因此,文件方法可能.cwl更有用。然而,對於簡單的情況,GUI 可能是一種有用的技術。

相關內容