-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
1.4以降のマニュアルの再構成を行う #1787
Comments
documentationリポジトリを作った。 |
注意事項:
|
変換作業でやること:
|
マニュアルの手順をリストで書き直すのは編集がたいへんなため、本来のマークアップの意味とは異なるが、見出し |
テーマは現在のものにこだわらず、AsciiDocで利用できるものを別途使用する。 |
Enju WS(2023-07-09) で決めた: 複数ファイルで入力して、セクションナンバーの自動割り付けはできなそうなのと、 |
画像の自動変換:
|
メモは NOTE 構文に置き換える: 変換元: <div class="alert alert-info memo" markdown="1">
【Memo】
* ユーザ名、利用者番号、貸出履歴が表示されます。
</div> 変換先: [NOTE]
====
* ユーザ名、利用者番号、貸出履歴が表示されます。
==== |
XMLコード記述: [source,xml]
----
<note>
<from>masao</from>
<to>nabeta</to>
<body>test test</body>
</note>
---- |
ファイルをまたいだリンクは以下のように書く: 書式: xref:filename.adoc#ID[リンクテキスト] 例: ** 参照:xref:enju_operation_4.adoc#list-images[運用マニュアル「画像の一覧表示」] 見出しにアンカーIDを振るには、以下の記法: [[list-images]]
==== 画像の一覧表示 原則使用しない記法以下は、原則、アンカーIDを付与してから参照するように変更したため使用しない: 例: また、貸出の履歴を保存する(xref:enju_user_3.adoc#_メールアドレスや名前などを変更する[3-2節参照])にチェックを入れておくと、返却した本も記録され、閲覧できるようになります。 注:節タイトルのアルファベットの大文字がある場合は小文字にすること。 |
ローカルでの実行
|
PDFの作成時には、
|
マニュアルそれぞれをまとめたPDFファイルを自動生成するスクリプトを スクリプトを実行すると、以下のファイルが生成されます:
|
メモ: @masao によると、htmlもpdfも節番号が付けられる方法がわかったらしい。 |
表 Table の書きかた .図書のフィールド項目名と対応する内容
[cols="1,1,2,2",frame=ends,stripes=even]
|===
|フィールド名 | 日本語名称 | 入力ルール及び説明 | 例
|manifestation_id
|Manifestation ID
|半角数字のみ。システムが自動付与するID。「資料の表示」画面のURL末尾にある数値。更新や削除に使用します。※新規作成時には使用しないでください。
// <!-- ( #872 ) いずれ:新規作成時にはこの列は無視されます。--></td>
|4
|=== |
同一ファイル内のセクション見出しへのリンクは以下の記法: <<tsv_id,(詳細)>> また、見出しにアンカーIDを振るには、以下の記法: [[tsv_id]]
==== TSVにおけるIDの扱いについて
。。。 |
現在のマニュアルは、章番号を手動で振らなければならず、メンテナンスに手間がかかる。Sphinxは章番号を自動で振ってくれるため、こちらに置き換える。以下を行った上でコンテンツの移行を行う。
参考:なぜやろうと思ったかの主旨
(#975)
The text was updated successfully, but these errors were encountered: