Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

[インデックス 12019] ファイルの概要

このコミットは、Go言語の公式ドキュメント、特にGo 1に関するドキュメント（doc/go1.htmlとdoc/go1.tmpl）におけるテーブルと水平線（<hr>タグ）の表示を改善することを目的としています。具体的には、テーブルを中央揃えにし、古いウェブデザインに見られるような「3Dボーダー」を無効にすることで、ドキュメントの視覚的な品質と現代的な外観を向上させています。

コミット

commit 5c3de8ccb3ebb299968a88780f65b9f7cbdaf5d3
Author: Russ Cox <rsc@golang.org>
Date:   Fri Feb 17 16:59:33 2012 -0500

    doc: fix tables
    
    R=golang-dev, r
    CC=golang-dev
    https://golang.org/cl/5676084

GitHub上でのコミットページへのリンク

https://github.com/golang/go/commit/5c3de8ccb3ebb299968a88780f65b9f7cbdaf5d3

元コミット内容

doc: fix tables

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/5676084

変更の背景

この変更が行われた2012年頃は、ウェブデザインのトレンドが大きく変化していた時期です。それ以前のウェブサイトでは、テーブルやボタンなどに立体感を持たせるために、デフォルトのボーダーやシャドウ効果が多用されていました。しかし、よりクリーンでフラットなデザインが主流になりつつあり、古いスタイルの「3Dボーダー」は時代遅れと見なされるようになりました。

Go 1のドキュメントも例外ではなく、デフォルトのHTML要素のスタイルが適用されており、特にテーブルの表示が視覚的に洗練されていない状態でした。このコミットは、ドキュメントの可読性と現代的な外観を向上させるために、テーブルをページの中央に配置し、視覚的に邪魔になる可能性のあるデフォルトのボーダーを削除することを目的としています。水平線（<hr>）についても同様に、よりシンプルで目立たないスタイルに変更することで、ドキュメント全体の統一感を高めています。

前提知識の解説

HTMLのテーブル (<table>) と水平線 (<hr>)

  • <table>: HTMLで表形式のデータを表示するために使用される要素です。行 (<tr>)、セル (<td> または <th>) などで構成されます。ブラウザはデフォルトでテーブルにボーダーやパディングなどのスタイルを適用します。
  • <hr>: HTMLでテーマの区切り（水平線）を表示するために使用される要素です。これもブラウザによってデフォルトのスタイルが適用され、しばしば立体的な線として表示されます。

CSS (Cascading Style Sheets)

CSSは、HTMLドキュメントの見た目（スタイル）を定義するための言語です。このコミットでは、以下のCSSプロパティが使用されています。

  • margin-left: auto; margin-right: auto;: ブロックレベル要素（この場合は<table>）を親要素内で水平方向に中央揃えにするための一般的なテクニックです。左右のマージンを自動計算させることで、要素が利用可能なスペースの中央に配置されます。
  • border-style: none;: 要素のボーダー（境界線）のスタイルを「なし」に設定します。これにより、デフォルトで表示されるボーダーが消去されます。
  • border-top: 1px solid black;: 要素の上部に1ピクセルの実線で黒いボーダーを設定します。このコミットでは、<hr>要素のデフォルトの立体的なボーダーを削除し、代わりにシンプルな細い黒い線に置き換えるために使用されています。

Go 1

Go 1は、Go言語の最初の安定版リリースです。2012年3月28日にリリースされ、Go言語の仕様が安定し、後方互換性が保証されるようになった画期的なバージョンでした。このコミットは、Go 1のリリースに向けてドキュメントの品質を向上させる作業の一環として行われたと考えられます。

doc/go1.html と doc/go1.tmpl

  • doc/go1.html: 最終的にブラウザで表示されるGo 1のドキュメントのHTMLファイルです。
  • doc/go1.tmpl: Go言語のテンプレートエンジンで使用されるテンプレートファイルである可能性が高いです。このテンプレートからgo1.htmlが生成されるため、両方のファイルに同じスタイル変更が適用されています。これにより、生成されるHTMLドキュメントに確実にスタイルが反映されるようになっています。

技術的詳細

このコミットは、HTMLドキュメントに直接<style>タグを挿入することで、インラインCSSとしてスタイルを適用しています。これは、特定のドキュメントにのみスタイルを適用したい場合や、既存のCSSファイルに影響を与えずに一時的な修正を行いたい場合に用いられる手法です。

追加されたCSSルールは以下の通りです。

  1. table { margin-left: auto; margin-right: auto; border-style: none; }

    • tableセレクタは、HTMLドキュメント内のすべての<table>要素にこのスタイルを適用することを意味します。
    • margin-left: auto; margin-right: auto; は、テーブルをその親要素内で水平方向に中央揃えにします。これは、ウェブページ上でテーブルの配置を整えるための標準的な方法です。
    • border-style: none; は、テーブルのデフォルトのボーダーを完全に削除します。これにより、古いブラウザやデフォルトスタイルシートによって適用される可能性のある「3Dボーダー」やその他の視覚的に邪魔なボーダーがなくなります。

  2. hr { border-style: none; border-top: 1px solid black; }

    • hrセレクタは、HTMLドキュメント内のすべての<hr>要素にこのスタイルを適用します。
    • border-style: none; は、水平線のデフォルトのボーダーを削除します。多くのブラウザでは、<hr>はデフォルトで立体的な線として描画されるため、これを無効にします。
    • border-top: 1px solid black; は、削除されたデフォルトのボーダーの代わりに、上部に1ピクセルの実線で黒いボーダーを設定します。これにより、水平線がシンプルでモダンな細い線として表示されるようになります。

これらの変更は、ドキュメントの視覚的な一貫性と現代性を向上させ、ユーザーエクスペリエンスを改善することを目的としています。

コアとなるコードの変更箇所

--- a/doc/go1.html
+++ b/doc/go1.html
@@ -7,6 +7,12 @@
 -->
 
 
+<!-- Center the tables, and disable the 1995 3D borders -->
+<style>
+table { margin-left: auto; margin-right: auto; border-style: none; }
+hr { border-style: none; border-top: 1px solid black; }\n</style>\n+\n <h2 id=\"introduction\">Introduction to Go 1</h2>
 
 <p>
 diff --git a/doc/go1.tmpl b/doc/go1.tmpl
index c31fa7f2cf..510f2f700c 100644
--- a/doc/go1.tmpl
+++ b/doc/go1.tmpl
@@ -3,6 +3,12 @@
 }-->
 {{donotedit}}\n \n+<!-- Center the tables, and disable the 1995-era 3D borders -->
+<style>
+table { margin-left: auto; margin-right: auto; border-style: none; }
+hr { border-style: none; border-top: 1px solid black; }\n</style>\n+\n <h2 id=\"introduction\">Introduction to Go 1</h2>
 
 <p>

コアとなるコードの解説

このコミットでは、doc/go1.htmlとdoc/go1.tmplのそれぞれに、HTMLの<head>セクション（またはそれに準ずる場所）に直接<style>タグが追加されています。

  • <!-- Center the tables, and disable the 1995 3D borders -->

    • これはHTMLコメントであり、追加されるCSSの目的を説明しています。「テーブルを中央揃えにし、1995年風の3Dボーダーを無効にする」という意図が明確に示されています。

  • <style>タグ

    • このタグ内にCSSルールが記述されています。

  • table { margin-left: auto; margin-right: auto; border-style: none; }

    • table要素に対して、左右のマージンをautoに設定することで、利用可能なスペース内で水平方向の中央に配置されるようにします。
    • border-style: none; は、テーブルの周囲にデフォルトで表示される可能性のあるボーダーをすべて削除します。これにより、クリーンな見た目になります。

  • hr { border-style: none; border-top: 1px solid black; }

    • hr要素（水平線）に対して、まずborder-style: none;でデフォルトの立体的なボーダーを削除します。
    • 次に、border-top: 1px solid black;で、上部に1ピクセルの実線で黒い線を追加します。これにより、シンプルで目立たない区切り線として機能します。

これらの変更は、Go 1ドキュメントの視覚的なプレゼンテーションを現代のウェブデザインの標準に合わせるための、シンプルかつ効果的な修正です。

関連リンク

  • Go Change-ID: https://golang.org/cl/5676084 (Goプロジェクトの内部変更リストシステムへのリンク)

参考にした情報源リンク