Как я должен предоставить помощь для связанного набора функций?

Question

Я собрал tfs.el , чтобы позволить разработчикам делать вещи TFS (извлечение, регистрация и т. Д.) Изнутри emacs.

В пакете tfs есть 13 интерактивных команд, таких как tfs/checkout, tfs/rename, tfs/diff и т. Д., И я хотел бы иметь возможность оказать помощь по всем из них водно место.Обзор всех доступных функций.

Что такое "способ emacs"?Я думал об определении дополнительной функции, такой как tfs/help, которая будет вызывать describe-function-1 для каждой из функций tfs, а затем представлять все это в буфере справки TFS.

Есть ли лучший способ?

Answer 1

Ну, есть много «путей Emacs».

Самым полезным было бы написать страницу info , см. Страницу «Информация для экспертов» , который в основном говорит использовать Texinfo и преобразовать это в info страницу.Вы можете быть настолько многословным, насколько захотите, и пользователь может искать, использовать гиперссылки и т. Д. Пользователь может легко попасть туда через Ch F tfs / checkout .

Другой способ, некоторые людиПохоже, для этого нужно написать короткие строки документации для каждой из команд, оканчивающиеся на «подробности см. в документации по tfs-mode», и поместить всю общую документацию в строку документации для режима tfs.

Другим способом, которым некоторые пакеты документируют вещи, является большой комментарий вверху файла tfs.el.

Выберите, у всех есть компромиссы.

Answer 2

У вас есть несколько связанных команд.Пока, я думаю, они связаны только своими именами.

На ум приходят две возможности:

• Создать режим для этого материала.Документируйте все в строке документа команды, которая включает / выключает режим.Это может быть основной режим или второстепенный режим.Если это второстепенный режим, он может быть локальным или глобальным для буфера.

• Создать группу (defgroup) для этого материала и документировать все в своей строке документа.

Основная идея состоит в том, чтобы как-то на самом деле связать эти команды: каким-то образом связать их вместе, так что вы можете документировать их вместе как документ для связки.

От руки, не зная больше, я думаю, что вы можете создать глобальный второстепенный режим.

Answer 3

Вы можете использовать

    (describe-bindings "\C-xv")