テンプレート:Compact TOC/docのソースを表示

{{Documentation subpage}}
{{Intricate template}}
<noinclude>{{翻訳中途|1=[http://en.wikipedia.org/w/index.php?title=Template:Compact_ToC/doc&oldid=510725110 英語版 "Template:Compact ToC/doc" 08:14, 4 Sep 2012 (UTC)]|date=2012年10月}}</noinclude>
記事の目次を作るテンプレートです。目次の内容は英字のAからZで、引数の指定によって関連項目や外部リンク節を含めることもできます。
<!-- 英語版の原文に内容の更新あり。[[:Template:Compact TOC/doc#Usage]]前後に加筆と、見出し構成の変更。英語版から転記して内部リンクに赤リンク予防の「:en:」、テンプレート無効化のため「tl:」を付与します。初版と英語版の直近版[https://en.wikipedia.org/w/index.php?diff=1108030413&oldid=510725110&title=Template%3ACompact_TOC%2Fdoc&diffmode=source  2022年9月2日05:08 (UTC) 時点における Cedar101 による版との差分] (→‎Full blank syntax:  syntaxhighlight) は、29人の利用者による、間の52版が非表示。

<!-- --Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]])--><!-- 

This is a [[H:TOC|table-of-contents]] replacement for alphabetical lists within mainspace articles. The template has all features of other TOC templates, such as optional "Top" "0–9" sections, and allows selecting other sections.

<nowiki>__TOC__</nowiki>
==Usage==
===Features===
* This template '''replaces''' the regular Table of Contents functionality. If you want a regular Table of Contents on a page where {{tl|Compact TOC}} is in use, use <code><nowiki>__FORCETOC__</nowiki></code> or <code><nowiki>__TOC__</nowiki></code> as explained at [[:en:HELP:TOC]].
* The compact format goes sideways: A B C D E F G H I J K L ....
* The centering or numbers are optional: center=yes, num=yes.
* The "Contents" heading can go on top (default) or the side (side=yes).
* Letter ranges can be set (''see below:'' [[:en:#Letters]]): A B C–F G H–K L...
* Some letters can be omitted, instead of 26 separate letters.
* Other headers can be listed in the TOC (''see below:'' [[:en:#Listing custom headers|#Listing custom headers]]).
** Set upper headers before "ABCDEF" by pre1, pre2, ... pre8.
** Set lower headers after "ABCDEF" by custom1, custom2, ... custom8.
* Conceal subheader link-text as "pre1name" over "pre1link" and "custom1name" over "custom1link" etc.
* Other options include: top=yes, seealso=yes, refs=yes, extlinks=yes, etc.

===Syntax=== -->
__TOC__

==目的==
<!-- This is a Table-of-Contents replacement for alphabetical lists: -->
これはアルファベットリストを表形式の目次(TOC: Table-of-Contents)に置き換えるものです：
<!-- :* The compact format goes sideways: A B C D E F G H I J K L .... -->
:* 横並びのコンパクトな形式にします:　A B C D E F G H I J K L ...
<!-- :* The centering or numbers are optional: center=yes, num=yes. -->
:* オプションを指定すると、中央揃えにするかどうか、また目次に並べる見出しの数などを指定できます： center=yes, num=yes.
<!-- :* The "Contents" heading can go on top (default) or the side (side=yes). -->
:* 「目次」の表示位置は、既定の画面上か横か、選べます：上(デフォルト), 横(side=yes).
<!-- :* Letter ranges can be set (''see below:'' [[#Letters]]): A B C–F G H–K L... -->
:* 表示する頭文字の範囲も設定できます。(下の[[#文字]]を参照): A B C-F G H-K L...
<!-- :* Some letters can be omitted, instead of 26 separate letters. -->
:* アルファベット26文字を全て置かずに、いくつか省いて非表示にもできます。
<!-- :* Other headers can be listed in the TOC (''see below:'' [[#Listing custom-headers|Listing custom-headers]]). -->
:* TOCの中に、頭文字以外の見出しを並べることも可能（下の　[[#目次に示す見出しをカスタム化|見出しをカスタム化した目次]]の書き方を参照）
<!-- ::* Set upper headers before "ABCDEF" by pre1, pre2, ... pre8.　 -->
::* 大文字の見出しを使うには、"ABCDEF"の前に、pre1, pre2, ... pre8 と書きます。([[#サンプル集]]節を見てください。)
<!-- ::* Set lower headers after "ABCDEF" by custom1, custom2, ... custom8.  -->
::* "ABCDEF"の後ろに小文字の見出しを置くには、custom1, custom2, ... custom8 と書きます。(サンプル集を見てください。)
:* <!-- :* Conceal subheader link-text as "pre1name" over "pre1link" and "custom1name" over "custom1link" etc.-->下位の見出しへのリンク文を非表示にするには、"pre1link" の代わりに "pre1name"、"custom1link" の代わりに "custom1name" を指定するなどします。
:* <!--  Other options include: top=yes, seealso=yes, refs=yes, extlinks=yes, etc.
The template has all features of other TOC templates, such as optional "Top" "0–9" sections, ''and'' allows selecting other sections.　
The template has all features of other TOC templates, such as optional "Top" "0–9" sections, ''and'' allows selecting other sections.-->その他のオプションもあります。配置（top=yes）のほか、関連項目節（seealso=yes）や出典節（refs=yes）、外部リンク節（extlinks=yes）その他を目次の項目にするかどうか。テンプレートには目次テンプレートが備えたその他の機能もあり、オプションで "Top" "0–9" を見出しにしたり、''さらに'' 部分の指定もできます。

==使い方==
;<!--Typical: -->一般的：

<nowiki>{{Compact ToC|symnum=yes}}</nowiki>


;<!-- For alphabetical only -->アルファベット順に限定する。

<nowiki>{{Compact ToC}}</nowiki> 


;<!-- For common applications:  -->よく使われる記述。

<nowiki>{{Compact ToC|center=yes|seealso=yes|refs=yes|further=yes}}</nowiki>

:<!-- or vertical: -->見出しを水平に配置。

<pre>
{{Compact ToC
 |center  = yes
 |seealso = yes
 |refs    = yes
 |further = yes
}}
</pre>


<!-- '''For maximum number of features and centered placement''' (leave off a parameter or change it to blank or "no" to disable a feature) -->'''要素を最大まで採用して中央揃えにする場合'''（要素を無効にするにはパラメータをコメントアウトするか、空欄に置き換えるか、等号の右に「no」と記入）

<pre>
{{Compact ToC
 |name=
 |side=yes
 |center=yes
 |right=
 |align=center
 |nobreak=yes
 |top=yes
 |num=yes
 |sym=yes
 |symnum=
 |pre1=
 |pre1name=
 |pre1link=
 ...
 |pre8=
 |pre8name=
 |pre8link=
 |prebreak=<br>
 |custom1=
 |custom1name=
 |custom1link=
 ...
 |custom8=
 |custom8name=
 |custom8link=
 |seealso=yes
 |notesfirst=
 |refs=yes
 |notes=yes
 |further=yes
 |extlinks=yes
 |a=
 ...
 |z=
}}</pre>

===Parameters===
<!-- ===パラメータ=== ここから翻訳中途、[https://en.wikipedia.org/w/index.php?title=Template%3ACompact_TOC%2Fdoc&oldid=1108030413 英語版 "Template:Compact ToC/doc#Parameters" |date=2022年9月2日05:08 (UTC) 時点における Cedar101 による版] (→‎Full blank syntax: syntaxhighlight)。|date=2022年9月2日、特定版は 1108030413 番。-->
* <code>name=</code>: change the heading to an alternative name instead of "Contents", or hide it completely by entering <code>name=no</code>
* <code>side=yes</code>: put the "Contents" heading on the left side with a colon, instead of the top without one
* <code>center=yes</code>: float TOC centered in the horizontal middle of the page, instead of floated left
* <code>right=yes</code>: align the TOC horizontally to the right of the page (may require <code><nowiki><br style="clear:right;" /></nowiki></code> after it, depending on page layout), instead of floated left (this parameter is mutually exclusive with the "center" option above, and should be used sparingly and with good reason)
* <code>nobreak=yes</code>: no linebreak between the A-B-C-etc. stuff and the See also/References/etc. stuff (note: does not affect the heading; use <code>side=</code> for that)
* <code>top=yes</code>: enable the "Top" link; this is only useful if this copy of the TOC is a secondary TOC not at the top of the page, e.g. in the middle of a long glossary. (Every rendered page has a hidden <code><nowiki><a name="top" id="top"></a></nowiki></code> above the sitenotice which makes this link work without having to do anything but enable it in the template.)
* <code>num=yes</code>: enable the "0–9" link for numeric entries section (create a heading of <code><nowiki>==0&amp;ndash;9==</nowiki></code> for the link to work)
* <code>sym=yes</code>: enable the "!$@" link for symbolic entries section
* <code>symnum=yes</code>: enable the "!–9" link for combined symbolic and numeric entries section (create a heading of <code><nowiki>==!&amp;ndash;9==</nowiki></code> for the link to work)
* <code>letters=no</code>: suppresses the "A", "B", ..., "Z" entries.
<!-- ------------------------------- Parameters pre1..pre8 -->
* <code>pre1</code> to <code>pre12</code>: list up to 12 extra section headers ''before'' (pre-list) the "ABCDEF" list. These appear as <nowiki>[[:en:Template:Compact_TOC/doc#pre1|pre1]]</nowiki>.
* <code>pre1name</code> to <code>pre12name</code>: modifies the way the pre-list section headers appear: <nowiki>[[:en:Template:Compact_TOC/doc#pre1|pre1name]]</nowiki>
* <code>pre1link</code> to <code>pre12link</code>: modifies the targets of the pre-list headers: <nowiki>[[:en:pre1link|pre1]]</nowiki>.
* <code>prebreak=yes</code>: set break-line after all pre-list headers
<!-- ------------------------------- Parameters custom1..8 -->
* <code>custom1</code> to <code>custom12</code>: add up to 12 extra "custom" sections after the "ABCDEF" list. These appear as <nowiki>[[:en:Template:Compact_TOC/doc#custom1|custom1]]</nowiki>.
* <code>custom1name</code> to <code>custom12name</code>: modifies the way the custom section headers appear: <nowiki>[[:en:Template:Compact_TOC/doc#custom1|custom1name]]</nowiki>
* <code>custom1link</code> to <code>custom12link</code>: modifies the targets of the custom sections: <nowiki>[[:en:custom1link|custom1]]</nowiki>. Use this only for linking to another page.  ''Use sparingly!'' About the only legitimate use for this is connecting the sub-pages of multi-page articles, like long lists that have been broken up. Do not repurpose the TOC as a makeshift navbox.
<!-- ------------------------- Parameters seealso, refs...-->
* <code>seealso=yes</code>: enable link to the "See also" section
* <code>notesfirst=yes</code>: enable link to the "Notes" section, but placed before "References"; ''do not use with <code>notes</code>'' (and do observe that it is plural)
* <code>refs=yes</code>: enable link to the "References" section (observe that it is plural)
* <code>notes=yes</code>: enable link to the "Notes" section (observe that it is plural)
* <code>further=yes</code>: enable link to the "Further reading" section
* <code>extlinks=yes</code>: enable link to the "External links" section
* <code>a=</code> through <code>z=</code>: individually disable particular letters that have no entries. ''Use with caution'' and check regularly to make sure that new entries do not require the removal of these parameters. Can also be used to create range links, e.g. "X-Z". ''(See following section for more detailed documentation of this feature.)''
** The equivalent of this for numbers is <code>0-9=</code> - note this is a hyphen and not a dash (the heading uses a dash)
* <code>allowtoc=yes</code>: disables the hiding of the automatically-generated table of contents that <code><nowiki>__NOTOC__</nowiki></code> usually hides. (Since this template's purpose is usually to ''replace the existing table of contents'', this functionality is usually only necessary on Wikipedia guideline pages that use this template in examples.)

== 文字 ==
<!-- Any letter can be omitted (i.e. when it has no entries in the list) by specifying it as a ''lower-case'' blank parameter:&nbsp; -->
いずれの頭文字も省略が可能で（つまりそれに属するエントリがない場合）、次のように必ず''小文字で'' 記し、パラメータの値が空であることを示します（訳注：次のサンプルでは「J」「Q」が非表示。）&nbsp;
{{tlx|Compact ToC|side&#61;yes|j&#61;|q&#61;}}
{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|j=|q=}}
|}
<!-- Or it can be replaced with an unlinked letter by using that letter ('''upper-case'''): -->あるいはリンクをつけない文字に置換できます（'''大文字'''で記入）。（訳注：次のサンプルでは「J」「Q」にリンクがありません。）

{{tlx|Compact ToC|side&#61;yes|j&#61;J|q&#61;Q}}
{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|j=J|q=Q}}
|}
<!-- ''Note:'' It is often better to create an empty placeholder span (e.g. <code><nowiki><span id="Q" /></nowiki></code> where the letter's heading would be in the page if it existed, since in most cases it is quite possible that it will come to exist in the future. Using the span-id avoids confusing new users who might not realize the TOC-template has skipped some letters. -->''注記''：安全策として常に空欄のプレースホルダを設けます（例えばそれぞれの文字がページ内に存在していて、見出しとして目次に置く場合、<code><nowiki><span id="Q" /></nowiki></code> と記述。ほとんどの場合、将来的にその頭文字の記事ができる可能性を否定できないため。合わせて、span-id を採用すると、目次のテンプレート TOC で一部の文字には一覧がないと気づかなくても、新規利用者を混乱させない工夫として有効。） 

範囲のリンクを作成するには、文字の割り当て機能が使えます。

{{tlx|Compact ToC|side&#61;yes|x&#61;<nowiki>[[#X-Z|X-Z]]</nowiki>|y&#61;|z&#61;}}
{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|x=[[#X-Z|X-Z]]|y=|z=}}
|}
<!-- The feature can also be used (very tediously) for linking to sub-articles (e.g., for [[Wikipedia:Naming conventions (long lists)|long lists]] that have been split into multiple pages): -->この機能はまた、下位ページの記事にリンクを書くこともできます（例：[[:en:Wikipedia:Naming conventions (long lists)|long lists]]{{en icon}}など複数の記事に分割された場合など。手間はかかる。）
 
{{tlx|Compact ToC|name&#61;<nowiki>[[</nowiki><var><!-- Articlename -->記事名</var><nowiki>]]</nowiki>|side&#61;yes|n&#61;<nowiki>[[</nowiki><var><!-- Articlename -->記事名</var> (N–Z)#N|N<nowiki>]]</nowiki>|o&#61;<nowiki>[[</nowiki><var>Articlename</var> (N–Z)#O|O<nowiki>]]</nowiki>|...|z&#61;<nowiki>[[</nowiki><var><!-- Articlename -->記事名</var> (N–Z)#Z|Z<nowiki>]]</nowiki>}}

{| style="margin-left:3.0em"
|{{Compact ToC|name=[[<!-- Articlename -->記事名]]|side=yes|n=[[<!-- Articlename -->記事名 (N–Z)#N|N]]|o=[[<!-- Articlename -->記事名 (N–Z)#O|O]]|p=[[<!-- Articlename -->記事名 (N–Z)#P|P]]|q=[[<!-- Articlename -->記事名 (N–Z)#Q|Q]]|r=[[<!-- Articlename -->記事名 (N–Z)#R|R]]|s=[[<!-- Articlename -->記事名 (N–Z)#S|S]]|t=[[<!-- Articlename -->記事名 (N–Z)#T|T]]|u=[[<!-- Articlename -->記事名 (N–Z)#U|U]]|v=[[<!-- Articlename -->記事名 (N–Z)#V|V]]|w=[[<!-- Articlename -->記事名 (N–Z)#W|W]]|x=[[<!-- Articlename -->記事名 (N–Z)#X|X]]|y=[[<!-- Articlename -->記事名 (N–Z)#Y|Y]]|z=[[<!-- Articlename -->記事名 (N–Z)#Z|Z]]}}
|}

<!-- Or, as another example: -->同じ結果を示す別の記述法の例。

{{tlx|Compact ToC|side&#61;yes|n&#61;<nowiki>[[</nowiki><var><!-- Articlename -->記事名</var> (N–Z)|&amp;nbsp;N–Z <small>(next page<!--次のページへ-->)</small><nowiki>]]</nowiki>|o&#61;|p&#61;|...|z&#61;}}

{| style="margin-left:3.0em"
|{{Compact ToC|side=yes|n=[[<!-- Articlename -->記事名 (N–Z)|&nbsp;N–Z <small><!-- (next page) -->次のページへ</small>]]|o=|p=|q=|r=|s=|t=|u=|v=|w=|x=|y=|z=}}
|}

== 目次に示す見出しをカスタム化 ==
<!-- == Listing custom-headers== 
The optional parameters pre1...pre8 and custom1...custom8 allow listing up to 16 other section-headers in the TOC, before or after, the "ABCDEF" list:-->
オプションのパラメータとして pre1...pre8 ならびに custom1...custom8 を当てると、目次に最大16件まで別の節見出しを示すことができます。その位置は、アルファベット順に整理した見出し「ABCDEF」の前もしくは後を指定します。
{{tlx|Compact ToC|name&#61;no|center&#61;yes|top&#61;yes|seealso&#61;yes|notes&#61;yes|custom1&#61;<!-- New section -->新しい節|custom2&#61;<!--  Additional section -->その他の節}}
{{Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=<!-- New section -->新しい節|custom2=<!--  Additional section -->その他の節}}

{{tlx|Compact ToC|name&#61;no|center&#61;yes|top&#61;yes|seealso&#61;yes|notes&#61;yes|custom1&#61;<!-- New section -->新しい節|custom1name&#61;<!-- Custom section name -->カスタム化した節名|custom2&#61;<!-- Outside page -->外部リンク|custom2link&#61;<!-- Main Page -->メインページ}}
{{Compact ToC|name=no|center=yes|top=yes|seealso=yes|notes=yes|custom1=<!-- New section -->新しい節|custom1name=<!-- Custom section name -->カスタム化した節名|custom2=<!-- Outside page -->外部リンク|custom2link=<!-- Main Page -->メインページ}}

<br><!-- Headers can be listed before & after "ABCDEF" using pre1 & custom1: -->見出しの配置は、「ABCDE」順一覧の前でも後でも指定できます。
: {{tlx|Compact ToC|center&#61;yes|align&#61;center|top&#61;yes|seealso&#61;yes<br>|pre1&#61;<!-- Scope of list -->一覧の範囲|pre2&#61;<!-- Abbreviations used -->使用する略号|prebreak&#61;&lt;br><br>|custom1&#61;<!-- Popular entries-->汎用される項目名|custom2&#61;<!-- Excluded entries -->除外した項目名|notes&#61;yes}}
{{Compact ToC|center=yes|align=center|top=yes|seealso=yes|pre1=<!-- Scope of list -->一覧の範囲|pre2=<!-- Abbreviations used -->使用する略号|prebreak=<br>|custom1=<!-- Popular entries-->汎用される項目名|custom2=<!-- Excluded entries -->除外した項目名|notes=yes}}

<br><!-- The separator text can be set to a mid-dot by "sep=&amp;middot;" : -->{{訳語疑問点範囲|1="sep=&amp;middot;" を使うと、[[区切り文字]]は半角中グロ記号に置き換わります|date=2022年9月|2=The separator text can be set to a mid-dot by <nowiki>"sep=&amp;middot;</nowiki>|cand_prefix=原文}}。 
: {{tlx|Compact ToC|center&#61;yes|align&#61;center|top&#61;yes|seealso&#61;yes<br>|pre1&#61;<!-- Scope of list -->一覧の範囲|pre2&#61;<!-- Abbreviations used -->使用する略号|prebreak&#61;&lt;br><br>|custom1&#61;<!-- Popular entries-->汎用される項目名|custom2&#61;<!-- Excluded entries -->除外した項目名|sep&#61;'''<nowiki>'''&amp;middot;'''</nowiki>'''}}
{{Compact ToC|center=yes|align=center|top=yes|seealso=yes|pre1=<!-- Scope of list -->一覧の範囲|pre2=<!-- Abbreviations used -->使用する略号|prebreak=<br>|custom1=<!-- Popular entries-->汎用される項目名|custom2=<!-- Excluded entries -->除外した項目名|notes=yes|sep='''&middot;'''}}

==== 省略形 ====
<!-- ====Shorthand==== -->
* <code>short1</code> をいちばん最初のパラメータに指定すると（<code>name=</code>の直前）省略形の記述ができます。

標準の表記で<nowiki>{{Compact ToC|side=yes|center=yes|nobreak=yes|refs=yes}}</nowiki>と記すところを、以下の省略形で代替します。

{{tlx|Compact ToC|short1}}

{{Compact ToC|short1}}

== サンプル集 ==
<!-- ==Examples== -->
{{tlx|Compact ToC|top&#61;yes}} <!--Example: top=yes -->
{| style="margin-left:2.0em"
|{{Compact ToC|top=yes}}
|}

{{tlx|Compact ToC|side&#61;yes|sym&#61;yes|num&#61;yes|refs&#61;yes|seealso&#61;yes|custom1&#61;<!-- Other -->その他}}
{| style="margin-left:2.0em"
|{{Compact ToC|side=yes|sym=yes|num=yes|refs=yes|custom1=<!-- Other -->その他}}
|}

{{tlx|Compact ToC|name&#61;Directory|top&#61;no|refs&#61;yes|notes&#61;yes|extlinks&#61;yes}}
{| style="margin-left:2.0em"
|{{Compact ToC|name=Directory|top=no|refs=yes|notes=yes|extlinks=yes}}
|}

{{tlx|Compact ToC|name&#61;no|side&#61;yes|right&#61;yes|symnum&#61;yes|seealso&#61;yes}}
{{Compact ToC|name=no|side=yes|right=yes|symnum=yes|seealso=yes}}<br style="clear:right;" />

{{tlx|Compact ToC|short1|num&#61;yes|sym&#61;yes|seealso&#61;yes|notesfirst&#61;yes|further&#61;yes|extlinks&#61;yes}}
{{Compact ToC|short1|num=yes|sym=yes|seealso=yes|notesfirst=yes|further=yes|extlinks=yes}}

== 関連項目 ==
* [[Help:マジックワード#目次]] - <nowiki>__NOTOC__</nowiki>や<nowiki>__TOC__</nowiki>など、目次に関するマジックワードの説明

=== 関連テンプレート ===
* {{Tl|Compact TOC}} 全英字
* {{Tl|TOC2}} あかさたな
* {{Tl|TOC3}} あかさたな行
* {{Tl|TOC4}} 全数字
* {{Tl|OTOC}} カスタマイズ可能
* {{Tl|CategoryTOC}} カテゴリ用
* {{Tl|Horizontal TOC}} 横並べ
<includeonly>{{Sandbox other||
[[Category:目次テンプレート]]
}}</includeonly>