Recent Changes

2018-11-30
2018-11-22
2018-10-15
2018-07-31
2018-06-26

>>OSDN general help (JP)

(Go to Japanese Help/Docs page)

Document Help

You can store all manner of document files from the 'Docs' menu - text, html, PDF, graphics and various types of office file. Each file is accessible through a unique URL and document version history is also possible. Also you can switch between English and Japanese documents based on the user's language environment.

Only the project admin and document admin can enter and edit documents. Anybody can view documents by default, but it is also possible to place viewer restrictions on each document.

The OSDN document facility includes categories (tabs) as well as the documents themselves. Each document exists in one or more category, divided between them, just like files in folders.

root
  +-- category1
  |       +-- doc1
  |       +-- doc2
  |
  +-- category2
  |       +-- doc3
  |
  +-- doc4
  +-- doc5

Entry of documents

Documents are entered either from the 'Docs' -> 'Submit' menu item or from the "Create new document" link at the top right of the list of documents (only shown for project and documents admin).

Document properties

Documents have properties as shown in the table below. They all use either the default value or have to have their value entered individually.

Doc nameDisplayed as title in the list of documents
ExplantionSupplementary information displayed underneath the title in the list of documents. Records concise summaries of the document contents etc.
Admin URL nameIdentifies the document. Unique name within the project. As it is also used for the URL it must be made up of alphanumeric characters, '-' (minus), '_' (underscore) and '.' (period) only.
Access typeDocument access rights."Public", where anybody can access it, is the standard, "Member" documents can only be accessed by project members while "Private" documents may only be accessed by the project and document admin.
LanguageSets document language. If you leave this as "Japanese" then it will be shown to users with a Japanese language environment. You can have two documents per admin-url - Japanese and English so it is possible to show one to English and one to Japanese language users.
CategoryKey (or tag) used to categorize documents. You can show just documents from a category by selecting it on the list of documents. It is possible set multiple categories.
File typeDocument file type. Set whether it is text, html, PDF, etc. This setting determines how the document's contents are displayed when you view them.
Upload fileWhen you want to upload a PDF, graphic or office file this is where you do it. Click 'browse' and select the file you want to upload.
Document contentsIf the document is a text or html file copy the contents here (or type it directly here).

Above are the new document properties. You can also set one document status in addition to them.

ActiveNormal display condition. Anybody can view it.
PendingOnly project and document admin can view it.
DeletedDeleted and unable to be viewed (however it is not actually deleted).

The document status can be changed by editing after it is first created.

Document viewing (access)

Documents are viewed from the 'Docs' menu. First displayed is a list of those documents that in the root category and those that are in both root and a higher level category.

You can also access documents directly using the following URL.

https://osdn.net/projects/<projectname>/docs/<admin URL name>
You can also set language and version to access them with URLs like the following:
https://osdn.net/projects/<projectname>/docs/<admin URL name>/<language>/<version>/<admin URL name>+<file extension>
When you omit the language from the URL the version displayed gives precedence to that which matches the user language environment (English or Japanese). If that language version of the document does not exist the other language is shown. Also if you omit the version then either the latest version, or that which has been set to be the 'archive version' is displayed.

Document editing

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

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

バージョン履歴の表示

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

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

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

言語切り替え

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」に設定してください。通常のテキストファイルと同様に、そのまま中身が表示されます。