Help/Docs - OSDN ヘルプ - OSDN Docs (JP)

＞＞OSDN全般のヘルプ

文書ヘルプ

「文書」タブからは、テキスト、HTML、PDF、画像ファイル、各種オフィスファイルなどのファイルを配置できます。それぞれのファイルはユニークなURLでアクセスでき、履歴管理も可能です。また、ユーザーの言語環境に応じて、日本語と英語の文書を切り替えられます。

文書を登録・編集できるのは、プロジェクト管理者と文書管理者のみです。閲覧はだれでもできますが、文書ごとに制限をかけることも可能になっています。

OSDNの文書機能には、文書とカテゴリ（タブ）の要素が存在します。各文書には、1つ以上のカテゴリが存在し、カテゴリによって仕分けします。ちょうど、ファイルとフォルダの関係のようになっています。

ルート
  +-- カテゴリ1
  |       +-- 文書1
  |       +-- 文書2
  |
  +-- カテゴリ2
  |       +-- 文書3
  |
  +-- 文書4
  +-- 文書5

文書の新規登録

文書を登録するには、プロジェクトメニューの「文書」タブから「文書の新規登録」か、文書一覧の右上に表示されている（プロジェクト管理者および文書管理者のみ）「文書の新規作成」から行えます。

文書の属性

文書には以下の表のような属性があります。それぞれデフォルト値を使うか、各自で入力する必要があります。

文書名	文書一覧でタイトルとして表示される
説明	文書一覧でタイトルの下部に補足説明として表示される。文書の内容を簡潔にまとめた文章などを記述
管理URL名	文書を特定する、プロジェクト内で一意の名前。URLにも利用するため、英数字、「-_.」（マイナス、アンダースコア、ピリオド）の文字から構成される必要がある
アクセスタイプ	文書のアクセス権。標準は全員がアクセスできる「Public」であり、プロジェクトメンバーのみがアクセスできる「Member」、プロジェクト管理者および文書管理者のみがアクセスできる「Private」がある
言語	文書の属性として言語を設定できる。「日本語」を設定しておいた場合、ユーザー（閲覧者）の言語環境が日本語であれば、その文書が表示される。1つの管理URL名につき、日本語と英語の2つの文書を設定できるので、英語ユーザーにはこれ、日本語ユーザーにはこれといった表示の切り分けが可能
カテゴリ	文書を分類するためのキー、タグ。文書一覧でカテゴリを選択すると、そのカテゴリが設定されている文書が表示される。複数のカテゴリを設定できる
ファイルタイプ	文書のファイルタイプ。テキストなのかHTMLなのか、PDFなのかを設定する。文書を表示した際、この設定によって文書の内容をどのように表示するかが決まる
アップロードファイル	文書として配置したいものが、PDFや画像ファイル、オフィス文書ファイルの場合は、この項目からアップロードする。「参照」ボタンを押し、アップロードしたいファイルを選択
文書の内容	文書の内容がテキストもしくはHTMLの場合、この欄へ中身をコピーもしくは記述する

以上は新規作成時の属性ですが、これらのほかにもう1つ文書のステータスも設定できます。

Active	通常の表示状態。誰でも閲覧可能
Pending	プロジェクト管理者および文書管理者のみ閲覧可能
Deleted	削除状態となり、閲覧できなくなる。ただし、実際には削除されていない

文書のステータスは、一度文書を作成してから、文書の編集から変更可能です。

文書の閲覧（文書へのアクセス）

文書の閲覧は、プロジェクトメニューの「文書」から行えます。最初に表示されるのはルートカテゴリに所属する（ルートを設定している）文書と、上位カテゴリにルートを持つカテゴリの一覧が表示されます。

また、以下のURLで文書に直接アクセスすることも可能です。

https://osdn.net/projects/＜プロジェクト名＞/docs/＜管理URL名＞

さらに、言語、バージョンを指定した、以下のようなURLでもアクセスできます。

https://osdn.net/projects/＜プロジェクト名＞/docs/＜管理URL名＞/＜言語＞/＜バージョン＞/＜管理URL名＞＋＜ファイルタイプによる拡張子＞

なお、言語を省略したURLでは、言語はユーザーの環境設定（日本語か英語）を優先し、その言語がなければ別の一方を表示します。また、バージョンを省略した際は、最新もしくはアクティブバージョンとして設定されているバージョンの文書が表示されます。

文書の編集

文書を編集するには、対象の文書を表示した状態で、「ファイル情報」の右上にある「編集」のリンクをクリックします。このリンクは編集権限のあるユーザー（プロジェクト管理者および文書管理者）のみ表示されます。

文書の編集が終わり、登録すると、その文書のバージョンが自動的にあがります。

バージョン履歴の表示

各文書は更新するたびにバージョンが上がっていく仕組みなっています。全バージョンの要約一覧、古い特定バージョンのみの表示、特定バージョンどうしの差分などを文書表示のファイル情報にあるリンクから閲覧できます。

特定のバージョンを標準にする

文書内容には通常、最新バージョンが表示されますが、表示する内容を特定のバージョンに戻したい、設定したい場合は、そのバージョンの文書を表示し、バージョン一覧に表示される「有効化」というリンクをクリックしてください。これによって、そのバージョンがアクティブバージョンとなり、通常の文書アクセスでは、そのバージョンが表示されるようになります。

言語切り替え

OSDNでは、ユーザーの言語環境として日本語と英語を設定できます。文書の表示はその言語設定によって切り替えることができ、1つの管理URL名に対して、日本語と英語の文書を登録できます。

日本語文書一覧と英語文書一覧の切り替え

文書一覧の画面は、標準でユーザーの設定環境に合わせて表示しています。いま日本語、英語のどちらで表示されているかは、カテゴリ一覧の右側にある国旗で確認できます。また、この国旗をクリックすることで、日本語文書一覧と英語文書一覧の切り替えが可能です。

なお、カテゴリは言語ごとに名前を設定できないので、どちらの言語環境でも同じ名前が表示されます。

対語文書の作成

ある日本語の文書に対する英語文書を作成するには、日本語文書を表示した状態から、「ファイル情報」の「言語」のところで「英語」をクリックすると、英語の文書を登録できます。共通するのは管理URL名で、文書名、概要、内容はそれぞれの言語で異なった内容を設定できます。

なお、英語環境に設定しているユーザーから文書一覧を見ると、日本語だけを用意している文書は一覧にはでてきません。右上にある国旗のアイコンで日本を選択して初めてそこに文書があることが確認できます。英語環境のユーザーにも何らかの形で文書の存在を示したい場合は、文書名と説明に「Japanease Only」とだけでも英語文書を作成しておくことをお勧めします。

カテゴリ（タグ）

文書には1つ以上のカテゴリがあり、複数のカテゴリを設定できます。文書の一覧を表示する際、そのカテゴリが基準となって一覧表示され、複数のカテゴリが存在する場合はそれぞれのカテゴリから文書にアクセスできます。

カテゴリの新規作成

新しいカテゴリを作成するには、「文書」タブの「管理」から行います。ここを選択して表示される画面の「カテゴリの追加」から、必要な項目を入力していきます。それぞれの項目の意味は以下のとおりです。

カテゴリ名	カテゴリとして表示される文字。日本語など任意の文字が利用可能。あとから編集可能
管理URL名	内部で管理している文字列。現在は利用する場面はないが、プロジェクト内で一意である必要がある。URLで利用できる英数字、「-_.」（マイナス、アンダースコア、ピリオド）の文字のみ利用可能。あとから編集可能
上位カテゴリ名	カテゴリはツリー構造を持つことができ、各カテゴリは必ず1つ上位（親）カテゴリを持つ。ルート（Root）カテゴリが最上位のカテゴリ。どのカテゴリを上位とするかはあとから編集可能

たとえば以下のように設定します。

カテゴリ名	開発仕様書
管理URL名	spec
上位カテゴリ名	ルート

カテゴリの編集

一度作成したカテゴリは、文書一覧で右側に表示されている「編集」リンクから行えます。カテゴリ名、管理名、ステータスを変更できます。

ステータスには、以下の値があります。

Active	通常の表示状態。誰でも閲覧可能
Hidden	プロジェクト管理者および文書管理者のみ閲覧可能
Deleted	削除状態となり、閲覧できなくなる。ただし、実際には削除されていない

ステータスを「Deleted」としたカテゴリは、プロジェクト管理者および文書管理者からも通常状態では見えなくなります。表示させたい場合は、プロジェクト管理者および文書管理者のみが文書一覧で右上に表示される「削除済みアイテムの表示」のチェックボックスにチェックを入れると表示されます。管理URL名が同じカテゴリは作成できないので、文字列が同じものを作成したい場合は、削除済みカテゴリを再利用するか、削除済みカテゴリの管理URL名を変更してください。

カテゴリの移動（上位カテゴリの変更）

カテゴリの移動（上位カテゴリの変更）は、プロジェクトメニューの「管理」にある「カテゴリの移動」から行います。移動するカテゴリを選択し、そのカテゴリの上位カテゴリを設定します。

文書にカテゴリを追加

文書へのカテゴリの追加は、文書を表示している状態から行えます。「ファイル情報」内に表示されているカテゴリ一覧の末尾に「追加」というリンクがあるので、そこをクリックすると、その文書に追加するカテゴリを選択できます。新しいカテゴリを追加する場合は、先にカテゴリを作成してから、追加してください。

また、プロジェクトメニューの「文書」－「管理」からは、すべての文書から特定の文書を選択してカテゴリを追加できます。

Q&A

Q：テキストを配置する際、ファイルでアップロードしたいのですが

A:文書の作成・編集で、ファイルタイプを「Plain Text」もしくは「HTML」にしていた際は、アップロードファイルの項目からファイルのアップロードが可能です。アップロードされたファイルは中身が取り出され、文書の中身として登録されます。

Q：一度作成した文書を削除したい場合は、どのようにしたらいいでしょうか？

A:文書の編集で削除状態（Deleted）にしてください。削除状態になった文書は一覧には表示されず、アクセスもできなくなります。

Q：削除した文書と同じファイル名（管理URL名）の文書を作成したい場合は？

A:削除した文書・カテゴリは、削除状態になってるだけで、実際には削除されません。そのためファイル（管理URL名）が同じ文書を作成しようと思っても、名前がぶつかり、作成できません。そのような場合は削除した文書を再利用するか、削除済み文書の管理URL名を変更してください。

Q：カテゴリを移動しようとしてもエラーが出てしまう

A:カテゴリの移動で上位カテゴリを選択する際、自分もしくは自分の下位にあるカテゴリは選択できません。どのカテゴリも「ルート」からたどれる必要があります（そうしないとだれからも見つけられない迷子のカテゴリになってしまいます）。カテゴリの移動で失敗する場合は、上位カテゴリの選択によってループしていないかどうか確認してください。

Q：HTMLの文書をWebページのようにではなく、ソースとして表示する方法はないでしょうか？

A:ファイルタイプがHTMLとなっており、文書内容がHTMLの場合は、文書を表示した際、HTMLが解釈され、そのHTMLよってどのようなページが表示されるかがわかります。HTMLのソースを表示しておきたい場合は、ファイルタイプを「Plain Text」に設定してください。通常のテキストファイルと同様に、そのまま中身が表示されます。