web-dev-qa-db-ja.com

技術文書を作成するためのWordpressのプラグイン?

WordPressを使用して、ソフトウェア製品の技術文書を作成したいと思います。階層的に配置された普通のWordPressページを使用しましたが、うまく機能しますが、それは素晴らしいことではありません。問題点:

  • Wordpressのページエディタはとても遅いです。
  • 階層を変更するためにページをドラッグアンドドロップすることはできません。
  • セクション1.1、1.2、1.2.3のように、セクション番号は維持されません。
  • 右側に自動作成された目次を作成する方法が見つかりませんでした。
  • コードを強調表示してインデントするためのタグが必要です。

私はおそらくこれらすべてのことを行うためにプラグインのコレクションを組み立てることができましたが、私たちはすでにそれにかなりの時間を費やしてきました、そしてまだ素晴らしい解決策を持っていません。

Confluenceはうまくいくでしょうが、Wordpressですべてを維持したいのですが。

優れた技術文書プラグインに関する提案はありますか?

2
user237815

あなたはいくつかのプラグインを使わなければならないでしょう。

Wordpressのページエディタは非常に遅い

それ以上のリソースを投げる、または「画面オプション」タブに表示されないようにするための機能を無効にしてください。何がなぜ遅いのかを明確にすることができれば、大量のページに同時に取り組む多数の人々がいなければ、本当に遅くなるべきではありません。

階層を変更するためにページをドラッグアンドドロップすることはできません

http://wordpress.org/extend/plugins/simple-page-ordering/ のようなプラグインが必要になります。

セクション1.1、1.2、1.2.3のように、セクション番号は維持されません。

ここには2つの選択肢があります。 "Sections"という名前のカスタムフィールドメタボックスを作成し、各ページの値に数値を入力します。これはクエリと表示が簡単ですが、組み込みの階層はありません。オプション2は、ページにカテゴリ(またはカスタム分類法)を使用し、それらを階層として持つ(これもスラグを簡単にするために使用する)か、単に CPT を使用することです。

右側に自動作成された目次を作成する方法が見つかりませんでした。

これにはさまざまなプラグインがあります。wordpress.orgで "TOC"を検索してください。あるいは上記の方法を使用する場合は、組み込みのWordPress関数を使用することができます(セクション分類を作成する場合は特に)。

コードを強調表示してインデントするためのタグが必要です。

私はこれが好きです、 http://wordpress.org/extend/plugins/syntaxhighlighter/ 、しかし他にも.orgが得意です。

5
Wyck

ドキュメンテーションにはWordPressを使います。私は以下のプラグインを使います

ページの右側にある目次には、 'table of contents plus'という名前のプラグインを使います。短いコード[toc]を使ってページに目次を挿入します。

ページを階層的に並べるために、 'CMSページツリービュー'という名前のプラグインを使います。これにより、ページまたはページグループをドラッグアンドドロップすることができます。

私のはRobohelpからWordPressへの切り替えでした、そして私は左側のサイドバーにページナビゲーションツリーが必要でした。これには 'wp-page tree'という名前のプラグインを使います。

2
Roy Joe