非コードファイルでの作業

画像をレンダリングして違いを見極める

GitHub Enterprise Server では、一般的な画像形式のいくつか (PNG、JPG、GIF、PSD、SVG など) を表示できます。 In addition to simply displaying them, there are several ways to compare differences between versions of those image formats.'

画像を表示する

GitHub Enterprise Server リポジトリにある画像は、直接アクセスして表示することができます。

SVG では現在、インラインスクリプトやアニメーションはサポートされていません。

差異を見る

画像は、見開き (2-Up)、スワイプ (Swipe)、およびオニオンスキン (Onion Skin)の 3 種類のモードで表示して比較できます。

見開き(2-Up)

見開き (2-Up) はデフォルトモードで、一度に両方の画像を見ることができます。 加えて、画像のサイズがバージョン間で変わっていれば、その違いがそのまま表れます。 このモードではサイズの違いが明瞭にわかります。アセットがより高い解像度にアップグレードされた場合などにサイズが変わります。

スワイプ

スワイプでは画像の部分を並べて表示することができます。 新旧画像間でなされた微妙な色変更がわかりづらいといった場合、 スワイプスライダーを問題の領域までドラッグして注目すると、違いが見えてきます。

オニオンスキン

オニオンスキンは、要素の移動量が小さくてわかりづらい場合に役立ちます。 ほとんど変わっていないように見えるアイコンが、もしかしたら 2 ピクセルほど左にずらされているかもしれません。その場合、 スライダーで不透明度を調節して、それが動くかどうかを見てください。

3Dファイルビューア

GitHub Enterprise Serverは、.stl 拡張子の 3D ファイルをホストしてレンダリングできます。

STLファイルを直接GitHub Enterprise Serverで見る場合、以下のことができます。

• クリックしてドラッグすることでモデルを回転させる。
• 右クリックしてからドラッグすることでビューを変換する。
• スクロールしてズームイン及びズームアウトする。
• 様々なビューモードをクリックしてビューを変更する。

Diff

STLファイルを含むコミットあるいは一連の変更を見る場合、そのファイルのdiffの前後を見ることができます。

デフォルトでは、変更されなかった物はすべてワイヤーフレームで表示されます。 追加分は緑になり、削除された部分は赤になります。

Revision Slider（リビジョンスライダー）オプションを選択し、ファイル上のスライダーを使って現在と以前のリビジョン間を行き来することもできます。

低速なパフォーマンスの修正

このアイコンがビューアの隅に表示されている場合、そのブラウザではWebGLテクノロジが利用できません。

使用しているコンピューターのハードウェアを完全に活用するためには、WebGLが必要です。 WebGLが有効化されている ChromeあるいはFirefoxなどのブラウザの利用をおすすめします。

エラー："Unable to display"（表示不能）

モデルが不正なら、GitHub はそのファイルを表示できないことがあります。 加えて、10 MB 以上のファイルは大きすぎて GitHub は表示できません。

他の場所へのモデルの埋め込み

インターネット上の別の場所に3Dファイルを表示するには、このテンプレートを変更し、JavaScriptをサポートするHTMLページに配置します。

<script src="https://embed.github.com/view/3d/<username>/<repo>/<ref>/<path_to_file>"></script>

たとえばモデルのURLがgithub.com/skalnik/secret-bear-clip/blob/master/stl/clip.stlなら、埋め込むコードは以下のようになるでしょう。

<script src="https://embed.github.com/view/3d/skalnik/secret-bear-clip/master/stl/clip.stl"></script>

デフォルトでは、埋め込まれるレンダラは幅420ピクセル高さ620ピクセルになりますが、 ?height=300&width=500というように高さと幅の変数をパラメータとしてURLの終わりに渡せば、この出力はカスタマイズできます。

CSV および TSV データをレンダリングする

GitHub では、.csv (カンマ区切り) 形式および .tsv (タブ区切り) 形式のファイルのレンダリングがサポートされています。

GitHub Enterprise Serverリポジトリにコミットされた .csv ファイルや .tsv ファイルを開くと、自動的にレンダリングされ、ヘッダや行番号を備えたインタラクティブな表として表示されます。 デフォルトでは、常に 1 番目の行がヘッダ行であるとみなされます。

行番号をクリックして特定の行にリンクすることも、Shift キーを押して複数行を選択することもできます。 あとは URL をコピーして送るだけです。

データを検索する

データセットから特定の値を見つけるには、ファイルの上にある検索バーで直接、入力を開始します。 行が自動的にフィルタされます。

エラーを処理する

時々、CSV や TSV が正常にレンダリングされないことがあります。 その場合、生テキストの末尾にエラーボックスが表示され、考えられる原因が示されます。

よくある原因として次のようなものがあります:

• 列カウントの不一致。 セルは空白でもかまいませんが、各行の区切り文字の数は同じである必要があります。
• ファイルサイズの超過。 レンダリングが機能するファイルのサイズは 512KB までです。 それより大きいと、ブラウザが低速になります。

PDF ドキュメントをレンダリングする

GitHub では PDF ドキュメントのレンダリングをサポートしています。

現在、PDF 内のリンクは無視されます。

文章ドキュメントの差分をレンダリングする

文章ドキュメントを含むコミットとプルリクエストには、そのドキュメントをソースとレンダリング済みのビューで表示する機能があります。

ソースビューでは入力された生テキストが表示されますが、レンダリング済みビューでは GitHub Enterprise Server でレンダリングされた様子を見ることができます。 たとえば、 Markdown での **bold** がレンダリング済みビューで bold と表示される、という違いがあります。

文章のレンダリングがサポートされるのは、github/markup によってサポートされるレンダリング済みドキュメントです。

• Markdown
• AsciiDoc
• Textile
• ReStructuredText
• Rdoc
• Org
• Creole
• MediaWiki
• Pod

をクリックすると、コミットの一環としてドキュメントに行った変更を表示できます。

属性変更を可視化する

読者に見せる文字部分とは異なり、属性への変更は、レンダリングされたドキュメントでは見えなくなります。Github ではそれをツールチップで示します。 たとえば、リンク URL が、あるウェブサイトから別のものに変更された場合、ツールチップで次のように示されます:

変更についてのコメントを入力する

コミットコメントは、ソースビュー内で行ごとにのみ追加できます。

ヘッダにリンクする

他のレンダリング済み文章ドキュメントと同様、ドキュメントのヘッダにマウスオーバーすると、リンクアイコンが作成されます。 レンダリング済み文章の diff の読者を特定のセクションにリンクできます。

複雑な diff を表示する

プルリクエストの中には、大きくて複雑なドキュメントでの多数の変更を含むものがあります。 変更の分析に時間がかかりすぎると、GitHub Enterprise Server が変更のレンダリングされたビューを常に生成できない場合があります。 これが発生した場合、レンダリングされたボタンをクリックするとエラーメッセージが表示されます。

その場合でもソースビューは変更の分析やコメント入力に使用できます。

HTML 要素を表示する

HTML ドキュメントへのコミットのレンダリング済みビューは、直接にはサポートしていません。 形式の中には、Markdown のように、任意の HTML をドキュメントに埋め込むことができるものがあります。 そうしたドキュメントが GitHub Enterprise Serverで表示される際、埋め込まれた HTML はプレビューで表示されますが、表示できないもの (埋め込み YouTube 動画など) もあります。

通常、埋め込み HTML を含むドキュメントへの変更のレンダリング済みビューでは、GitHub Enterprise Server のドキュメントのビューでサポートされている要素への変更を表示します。 埋め込み HTML を含むドキュメントへの変更のレビューは、完全を期して、常にレンダリング済みとソースの両方のビューで行う必要があります。

Mapping geoJSON files on GitHub

GitHub Enterprise Server は、GitHub Enterprise Server リポジトリでの geoJSON および topoJSON マップ ファイルのレンダリングをサポートしています。 .geojson または .topojson 拡張子を使って、通常と同じようにファイルをコミットするだけです。 .json 拡張子の付いたファイルもサポートされますが、type が FeatureCollection、GeometryCollection、または topology に設定されている場合に限られます。 コミット後、GitHub.com で geoJSON ファイルのパスに移動してください。

右側にある紙アイコンをクリックすると、そのファイル ドキュメントに加えられた変更も、コミットの一部として表示されます。

ジオメトリのタイプ

GitHub Enterprise Server のマップは Leaflet.js を使用し、geoJSON の仕様 (Point、LineString、Polygon、MultiPoint、MultiLineString、MultiPolygon、GeometryCollection) に概要が示されているジオメトリのタイプをすべてサポートしています。 TopoJSON ファイルは "Topology" タイプで、topoJSON の仕様に従っている必要があります。

フィーチャーのスタイリング

GeoJSON オブジェクトのプロパティで追加のメタデータを渡すと、特定の色を指定する、説明アイコンを追加するなど、フィーチャーの表示方法をカスタマイズすることができます。 オプションは次のとおりです:

• marker-size - small、medium、または large
• marker-color - 有効な RGB 16 進カラー
• marker-symbol - Maki プロジェクトまたは英数字 1 文字 (a ～ z または 0 ～ 9) のアイコン ID
• stroke - ポリゴンの辺やラインの色 (RGB)
• stroke-opacity - ポリゴンの辺やラインの不透明度 (0.0 ～ 1.0)
• stroke-width - ポリゴンの辺やラインの幅
• fill - ポリゴンの内部の色 (GRB)
• fill-opacity - ポリゴンの内部の透明度 (0.0 ～ 1.0)

詳細は simplestyle 公開仕様のバージョン 1.1.0 を参照してください。

マップを他の場所に埋め込む

GeoJSON マップを GitHub Enterprise Server 以外の場所で使用するには、 次のテンプレートを修正し、JavaScript をサポートしている任意の HTML ページに貼り付けてください (例: GitHub Pages)。

<script src="https://embed.github.com/view/geojson/<username>/<repo>/<ref>/<path_to_file>"></script>

たとえば、マップの URL が github.com/benbalter/dc-wifi-social/blob/master/bars.geojson であれば、埋め込みコードは次のようになります:

<script src="https://embed.github.com/view/geojson/benbalter/dc-wifi-social/master/bars.geojson"></script>

デフォルトでは、埋め込まれるマップのサイズは 420px x 620px ですが、最後のパラメータとして、?height=300&width=500 のように height 変数と width 変数 を渡せば、出力をカスタマイズすることができます。

クラスタリング

マップに大量のマーカー (およそ 750 以上) が設定されている場合、ズーム レベルが大きいときは近隣のマーカーが自動的にクラスタ化されます。 クラスタをクリックしてズームするだけで、個々のマーカーが表示されます。

基になるマップに問題がある

基になるマップ データ (通りの名前、道路など) は、編集可能な無料の世界地図をコラボレーションによって作るプロジェクト、OpenStreetMap を利用しています。 オープンソースなので、何か不具合に気づいた場合は、ぜひサインアップして修正をサブミットしてください。

トラブルシューティング

geoJSON ファイルのレンダリングに問題がある場合は、geoJSON 文法チェッカーでそのファイルを実行し、有効な geoJSON ファイルであることを確認してください。 ポイントが、意図しない場所 (海の中など) にある場合、そのデータには、現在サポートされていない投影法が使われている可能性があります。 現在、GitHub Enterprise Serverでサポートされているのは urn:ogc:def:crs:OGC:1.3:CRS84 投影だけです。

また、10 MB を超えるような大きな .geojson ファイルは、ブラウザではレンダリングできません。 その場合は通常、次のようなメッセージが表示されます:

その場合でも、.geojson ファイルを TopoJSON に変換すればデータをレンダリングできます。TopoJSONは、ファイルサイズを最大 80% まで縮小できる圧縮形式です。 ファイルを小さいチャンクに分割し (州ごと、年ごとなど)、データを複数のファイルとしてリポジトリに格納することは、もちろんいつでもできます。

他のリソース

• Leaflet.js geojson ドキュメント
• MapBox マーカースタイリングのドキュメント
• TopoJSON Wiki

Working with Jupyter Notebook files on GitHub

When you add Jupyter Notebook or IPython Notebook files with a .ipynb extension on GitHub Enterprise Serverのインスタンス, they will render as static HTML files in your repository.

カスタム JavaScript プロットなど、Notebook のインタラクティブ機能は、GitHub Enterprise Serverのインスタンス のリポジトリでは機能しません。 例については、リンキングおよび Interactions.ipynb を参照してください。

レンダリングした JavaScript コンテンツで Jupyter notebook を表示する、または、notebook ファイルを他のユーザーと共有する場合、nbviewer を使用できます。 例については、nbviewerでレンダリングされたリンキングおよびInteractions.ipynb を参照してください。

Jupyter notebook の完全にインタラクティブなバージョンを表示するには、notebook サーバーをローカルに設定します。 詳細は Jupyter の公式ドキュメントを参照してください。

トラブルシューティング

Jupyter notebook ファイルを静的 HTML でレンダリングできない場合は、nbconvert コマンドを使用してコマンドラインでローカルにファイルを変換できます:

$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb

参考リンク

• Jupyter notebook の GitHub リポジトリ
• Jupyter notebooks のギャラリー