文書を作成する

本節では，GeoNetwork一致文書を作成するためのいくつかのガイドラインを提供する.

参考

文書に貢献する最も迅速で簡単な方法は登録である GitHub account ページ上部の“GitHubで編集する”リンクをクリックすることで文書ページを編集します。(参照されたい) code repository doc ）。

文書を構築する

ソースコードから文書を構築するには以下のツールが必要である.

  • Java JDK 1.8, Python

  • Maven 3.1.0+ ：インストール後 Maven コマンドシェルでは次のような形で提供すべきである mvn それがそうです。

  • make ：インストール後 make コマンドシェルでは次のような形で提供すべきである make それがそうです。

  • 獅子面像 ：参照されたい Sphinx もっと細かいことを知っています。実装後，以下の命令を実行することで利用可能かどうかを確認する. sphinx-build --version それがそうです。

  • sphinx-bootstrap-theme それがそうです。

生成ツールをインストールするには、以下の操作を実行してください。

sudo apt install make
sudo apt install python3-pip
sudo pip install sphinx
sudo pip install sphinx-bootstrap-theme
sudo pip install sphinx_rtd_theme

そして、以下のコマンドを用いて英語文書を構築します。

git clone https://github.com/geonetwork/doc
cd doc
mvn clean install

文書構築に誤りがない場合は、htmlファイルにアクセスしてください doc\target\en\index.html それがそうです。

いくつかの言語(現在：ES，fr，ge，it，ko，nl，cz，ca，fi，is)を用いてすべての文書を構築するには，以下の操作を実行してください：

mvn clean install -Pall

内部バージョンの最新の翻訳バージョンを取得したい場合は、実行してください。

mvn clean install -Platest,all

標準文書の構築

重要

標準とエディタ配置に関する文書はGeoNetworkソースコードで使用される. schema-doc プラグインです。したがって、以下のファイルを手動で編集しないでください。

  • ドキュメント/マニュアル/ソース/添付ファイル/標準/*

  • ドキュメント/マニュアル/ソース/カスタマイズ-アプリケーション/エディタ-UI/作成-カスタマイズ-editor.rst

これらのファイルをTRANSPEFEXに変換しないでください。翻訳はプラグイン自体で行われなければならない。これらのファイルを更新するには、GeoNetworkリポジトリをクローンし、以下のコマンドを使用してください。

cd docs/schema-doc
mvn clean install

更新されたファイルをチェックしてドキュメントリポジトリに提出します。

ReStrufredTextファイルの編集

文書を更新するには、テキストエディタで編集してください .rst ファイルです。以下をチェックすることで、使用する用語が正しいことを確認します 様式案内書 それがそうです。変更を保存し、ドキュメントを構築し、HTMLファイルを開いて変更をプレビューします。変更準備ができて項目に提出する場合は、中の手順で操作してください 引取要求を出す それがそうです。

獅子面像

本節では，Sphinxを用いた有用なヒントをいくつか提供する.

新しい警告を導入しないでください

文書を構築する際には，Sphinxはリンク切断，文法誤りなどに関する警告を印刷する.新しいのを導入しないでください。

Buildディレクトリを削除して文書を完全に再生成して、警告があるかどうかを確認したほうがいいです。

mvn clean install

代わる

Substitutions 多くの場所で必要な値を定義するのに有用である(例えば、ファイルの位置など).

これらの値は定義されている rst_epilog Conf.pyでは：

.. |jdbc.properties| replace:: WEB-INF/config-db/jdbc.properties

適切なときに使用します

Configure the database in |jdbc.properties| ...


After installation look to |install.homepage|_ on your web browser.

バージョンが追加され、バージョンが変更され、破棄されました

ライオンの顔像を使って versionadded そして versionchanged 新しい機能をマークしたり、機能を変更したりするための命令。例えば：

Creating overview from WMS
==========================

.. versionadded:: 3.0

In the *add overview panel*, select the *add from WMS* link to create
an image from the WMS referenced in the metadata record to illustrate
the dataset in a specific area.

...

使用すべきである. versionchanged コマンドは、どのように変化したかを説明する文が一般的に関連している：

Configuring LDAP
================

.. versionchanged:: 2.10.0
   Previous versions was setting LDAP parameters from the administration
   panel.

...

使用 deprecated 指示は、ある機能がこれ以上利用可能でない場合。

また会いましょう

多くの部分は、モジュール文書または外部文書への参照リストを含む。これらのリストは seealso 命令は通常，どのサブ節のすぐ前の節に置かれる.

文書を翻訳する

Github doc repository この文書の英語バージョンが含まれています。すべての翻訳作業はTransifex Webインタフェース上で行われなければならない.どの属性ファイルもこのリポジトリに提出されてはいけません。

いくつかの新しいセグメントを追加するか、または既存のセグメント上のテキストを更新する場合、Transifexフィールドは、この変更がすべての言語に伝播することを保証するために更新されなければならない。これを実現するためには、以下のコマンドを実行してください。

Transformfexから翻訳バージョンをダウンロードするには、Transifexコマンド行クライアント：https：//docs.transportfex.com/client/installing-the-client.com.cn/install-the-client.com/client.com/install-the-クライアントが必要になります。TransifexクライアントはPythonで書かれているので、ほとんどのシステムで動作することができます。これを実装する最も簡単な方法はpipを用いることである.

生成ツールをインストールするには、以下の操作を実行してください。

sudo pip install sphinx-intl
sudo pip install transifex-client

インストールが完了したら、Transformfexユーザー：https：//docs.transportfex.com/client/client-configurationを設定する必要があります。 ~/.transifexrc それがそうです。このプロファイルは、各ユーザに対して一意であり、ホームディレクトリに格納されています。

[https://www.transifex.com]
username = your_username/api
token =
password = p@ssw0rd/api_token
hostname = https://www.transifex.com

Transifex上の変換を更新する：

make update_translations

構築に新しい言語を追加するためには，ファイルhttps：//github.com/geonetwork/doc/blob/Development/Makefile#L 59を編集し，それのために文書を構築する言語を追加する必要がある.

Https：//geonnetwork-opensource.orgページで利用可能であることをご希望の場合は、広報をしていることを確認し、https：//github.com/geonetwork/WebSiteプロジェクトについて意見を求めてください。