[rustc.git] / src / test / rustdoc-gui / headings.goml

// This test checks that headers (a) have the correct heading level, (b) are the right size,
// and (c) have the correct underlining (or absence of underlining).
// The sizes may change as design changes, but try to make sure a lower header is never bigger than
// its parent headers. Also make sure lower headers don't have underlines when their parents lack
// an underline.
// Most of these sizes are set in CSS in `em` units, so here's a conversion chart based on our
// default 16px font size:
// 24px    1.5em
// 22.4px  1.4em
// 20.8px  1.3em
// 18.4px  1.15em
// 17.6px  1.1em
// 16px    1em
// 15.2px  0.95em  
goto: file://|DOC_PATH|/test_docs/struct.HeavilyDocumentedStruct.html

assert-css: ("h1.fqn", {"font-size": "24px"})
assert-css: ("h1.fqn", {"border-bottom-width": "1px"})

assert-css: ("h2#top-doc-prose-title", {"font-size": "20.8px"})
assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "18.4px"})
assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
assert-css: ("h4#top-doc-prose-sub-sub-heading", {"font-size": "17.6px"})
assert-css: ("h4#top-doc-prose-sub-sub-heading", {"border-bottom-width": "1px"})

assert-css: ("h2#fields", {"font-size": "22.4px"})
assert-css: ("h2#fields", {"border-bottom-width": "1px"})
assert-css: ("h3#title-for-field", {"font-size": "20.8px"})
assert-css: ("h3#title-for-field", {"border-bottom-width": "0px"})
assert-css: ("h4#sub-heading-for-field", {"font-size": "16px"})
assert-css: ("h4#sub-heading-for-field", {"border-bottom-width": "0px"})

assert-css: ("h2#implementations", {"font-size": "22.4px"})
assert-css: ("h2#implementations", {"border-bottom-width": "1px"})

assert-css: ("#impl > h3.code-header", {"font-size": "17.6px"})
assert-css: ("#impl > h3.code-header", {"border-bottom-width": "0px"})
assert-css: ("#method\.do_nothing > h4.code-header", {"font-size": "16px"})
assert-css: ("#method\.do_nothing > h4.code-header", {"border-bottom-width": "0px"})

assert-css: ("h4#title-for-struct-impl-doc", {"font-size": "16px"})
assert-css: ("h4#title-for-struct-impl-doc", {"border-bottom-width": "0px"})
assert-css: ("h5#sub-heading-for-struct-impl-doc", {"font-size": "16px"})
assert-css: ("h5#sub-heading-for-struct-impl-doc", {"border-bottom-width": "0px"})
assert-css: ("h6#sub-sub-heading-for-struct-impl-doc", {"font-size": "15.2px"})
assert-css: ("h6#sub-sub-heading-for-struct-impl-doc", {"border-bottom-width": "0px"})

assert-css: ("h5#title-for-struct-impl-item-doc", {"font-size": "16px"})
assert-css: ("h5#title-for-struct-impl-item-doc", {"border-bottom-width": "0px"})
assert-css: ("h6#sub-heading-for-struct-impl-item-doc", {"font-size": "15.2px"})
assert-css: ("h6#sub-heading-for-struct-impl-item-doc", {"border-bottom-width": "0px"})
assert-css: ("h6#sub-sub-heading-for-struct-impl-item-doc", {"font-size": "15.2px"})

goto: file://|DOC_PATH|/test_docs/enum.HeavilyDocumentedEnum.html

assert-css: ("h1.fqn", {"font-size": "24px"})
assert-css: ("h1.fqn", {"border-bottom-width": "1px"})

assert-css: ("h2#top-doc-prose-title", {"font-size": "20.8px"})
assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "18.4px"})
assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
assert-css: ("h4#top-doc-prose-sub-sub-heading", {"font-size": "17.6px"})
assert-css: ("h4#top-doc-prose-sub-sub-heading", {"border-bottom-width": "1px"})

assert-css: ("h2#variants", {"font-size": "22.4px"})
assert-css: ("h2#variants", {"border-bottom-width": "1px"})

assert-css: ("h4#none-prose-title", {"font-size": "16px"})
assert-css: ("h4#none-prose-title", {"border-bottom-width": "0px"})
assert-css: ("h5#none-prose-sub-heading", {"font-size": "16px"})
assert-css: ("h5#none-prose-sub-heading", {"border-bottom-width": "0px"})

assert-css: ("h4#wrapped-prose-title", {"font-size": "16px"})
assert-css: ("h4#wrapped-prose-title", {"border-bottom-width": "0px"})
assert-css: ("h5#wrapped-prose-sub-heading", {"font-size": "16px"})
assert-css: ("h5#wrapped-prose-sub-heading", {"border-bottom-width": "0px"})

assert-css: ("h5#wrapped0-prose-title", {"font-size": "16px"})
assert-css: ("h5#wrapped0-prose-title", {"border-bottom-width": "0px"})
assert-css: ("h6#wrapped0-prose-sub-heading", {"font-size": "15.2px"})
assert-css: ("h6#wrapped0-prose-sub-heading", {"border-bottom-width": "0px"})

assert-css: ("h5#structy-prose-title", {"font-size": "16px"})
assert-css: ("h5#structy-prose-title", {"border-bottom-width": "0px"})
assert-css: ("h6#structy-prose-sub-heading", {"font-size": "15.2px"})
assert-css: ("h6#structy-prose-sub-heading", {"border-bottom-width": "0px"})

assert-css: ("h2#implementations", {"font-size": "22.4px"})
assert-css: ("h2#implementations", {"border-bottom-width": "1px"})

assert-css: ("#impl > h3.code-header", {"font-size": "17.6px"})
assert-css: ("#impl > h3.code-header", {"border-bottom-width": "0px"})
assert-css: ("#method\.do_nothing > h4.code-header", {"font-size": "16px"})
assert-css: ("#method\.do_nothing > h4.code-header", {"border-bottom-width": "0px"})

assert-css: ("h4#title-for-enum-impl-doc", {"font-size": "16px"})
assert-css: ("h4#title-for-enum-impl-doc", {"border-bottom-width": "0px"})
assert-css: ("h5#sub-heading-for-enum-impl-doc", {"font-size": "16px"})
assert-css: ("h5#sub-heading-for-enum-impl-doc", {"border-bottom-width": "0px"})
assert-css: ("h6#sub-sub-heading-for-enum-impl-doc", {"font-size": "15.2px"})
assert-css: ("h6#sub-sub-heading-for-enum-impl-doc", {"border-bottom-width": "0px"})

assert-css: ("h5#title-for-enum-impl-item-doc", {"font-size": "16px"})
assert-css: ("h5#title-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
assert-css: ("h6#sub-heading-for-enum-impl-item-doc", {"font-size": "15.2px"})
assert-css: ("h6#sub-heading-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
assert-css: ("h6#sub-sub-heading-for-enum-impl-item-doc", {"font-size": "15.2px"})
assert-css: ("h6#sub-sub-heading-for-enum-impl-item-doc", {"border-bottom-width": "0px"})

assert-text: (".sidebar .others h3", "Modules")
assert-css: (".sidebar .others h3", {"border-bottom-width": "1px"}, ALL)

goto: file://|DOC_PATH|/test_docs/union.HeavilyDocumentedUnion.html

assert-css: ("h1.fqn", {"font-size": "24px"})
assert-css: ("h1.fqn", {"border-bottom-width": "1px"})

assert-css: ("h2#top-doc-prose-title", {"font-size": "20.8px"})
assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "18.4px"})
assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})

assert-css: ("h2#fields", {"font-size": "22.4px"})
assert-css: ("h2#fields", {"border-bottom-width": "1px"})

assert-css: ("h3#title-for-union-variant", {"font-size": "20.8px"})
assert-css: ("h3#title-for-union-variant", {"border-bottom-width": "0px"})
assert-css: ("h4#sub-heading-for-union-variant", {"font-size": "16px"})
assert-css: ("h4#sub-heading-for-union-variant", {"border-bottom-width": "0px"})

assert-css: ("h2#implementations", {"font-size": "22.4px"})
assert-css: ("h2#implementations", {"border-bottom-width": "1px"})

assert-css: ("#impl > h3.code-header", {"font-size": "17.6px"})
assert-css: ("#impl > h3.code-header", {"border-bottom-width": "0px"})
assert-css: ("h4#title-for-union-impl-doc", {"font-size": "16px"})
assert-css: ("h4#title-for-union-impl-doc", {"border-bottom-width": "0px"})
assert-css: ("h5#sub-heading-for-union-impl-doc", {"font-size": "16px"})
assert-css: ("h5#sub-heading-for-union-impl-doc", {"border-bottom-width": "0px"})

assert-css: ("h5#title-for-union-impl-item-doc", {"font-size": "16px"})
assert-css: ("h5#title-for-union-impl-item-doc", {"border-bottom-width": "0px"})
assert-css: ("h6#sub-heading-for-union-impl-item-doc", {"font-size": "15.2px"})
assert-css: ("h6#sub-heading-for-union-impl-item-doc", {"border-bottom-width": "0px"})

goto: file://|DOC_PATH|/test_docs/macro.heavily_documented_macro.html

assert-css: ("h1.fqn", {"font-size": "24px"})
assert-css: ("h1.fqn", {"border-bottom-width": "1px"})

assert-css: ("h2#top-doc-prose-title", {"font-size": "20.8px"})
assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "18.4px"})
assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
Commit	Line	Data
3c0e092e XL	1	// This test checks that headers (a) have the correct heading level, (b) are the right size,
	2	// and (c) have the correct underlining (or absence of underlining).
	3	// The sizes may change as design changes, but try to make sure a lower header is never bigger than
	4	// its parent headers. Also make sure lower headers don't have underlines when their parents lack
	5	// an underline.
	6	// Most of these sizes are set in CSS in `em` units, so here's a conversion chart based on our
	7	// default 16px font size:
	8	// 24px 1.5em
	9	// 22.4px 1.4em
	10	// 20.8px 1.3em
	11	// 18.4px 1.15em
	12	// 17.6px 1.1em
	13	// 16px 1em
	14	// 15.2px 0.95em
	15	goto: file://\|DOC_PATH\|/test_docs/struct.HeavilyDocumentedStruct.html
	16
	17	assert-css: ("h1.fqn", {"font-size": "24px"})
	18	assert-css: ("h1.fqn", {"border-bottom-width": "1px"})
	19
	20	assert-css: ("h2#top-doc-prose-title", {"font-size": "20.8px"})
	21	assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
	22	assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "18.4px"})
	23	assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
	24	assert-css: ("h4#top-doc-prose-sub-sub-heading", {"font-size": "17.6px"})
	25	assert-css: ("h4#top-doc-prose-sub-sub-heading", {"border-bottom-width": "1px"})
	26
	27	assert-css: ("h2#fields", {"font-size": "22.4px"})
	28	assert-css: ("h2#fields", {"border-bottom-width": "1px"})
	29	assert-css: ("h3#title-for-field", {"font-size": "20.8px"})
	30	assert-css: ("h3#title-for-field", {"border-bottom-width": "0px"})
	31	assert-css: ("h4#sub-heading-for-field", {"font-size": "16px"})
	32	assert-css: ("h4#sub-heading-for-field", {"border-bottom-width": "0px"})
	33
	34	assert-css: ("h2#implementations", {"font-size": "22.4px"})
	35	assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
	36
	37	assert-css: ("#impl > h3.code-header", {"font-size": "17.6px"})
	38	assert-css: ("#impl > h3.code-header", {"border-bottom-width": "0px"})
	39	assert-css: ("#method\.do_nothing > h4.code-header", {"font-size": "16px"})
	40	assert-css: ("#method\.do_nothing > h4.code-header", {"border-bottom-width": "0px"})
	41
	42	assert-css: ("h4#title-for-struct-impl-doc", {"font-size": "16px"})
	43	assert-css: ("h4#title-for-struct-impl-doc", {"border-bottom-width": "0px"})
	44	assert-css: ("h5#sub-heading-for-struct-impl-doc", {"font-size": "16px"})
	45	assert-css: ("h5#sub-heading-for-struct-impl-doc", {"border-bottom-width": "0px"})
	46	assert-css: ("h6#sub-sub-heading-for-struct-impl-doc", {"font-size": "15.2px"})
	47	assert-css: ("h6#sub-sub-heading-for-struct-impl-doc", {"border-bottom-width": "0px"})
	48
	49	assert-css: ("h5#title-for-struct-impl-item-doc", {"font-size": "16px"})
	50	assert-css: ("h5#title-for-struct-impl-item-doc", {"border-bottom-width": "0px"})
	51	assert-css: ("h6#sub-heading-for-struct-impl-item-doc", {"font-size": "15.2px"})
	52	assert-css: ("h6#sub-heading-for-struct-impl-item-doc", {"border-bottom-width": "0px"})
	53	assert-css: ("h6#sub-sub-heading-for-struct-impl-item-doc", {"font-size": "15.2px"})
	54
	55	goto: file://\|DOC_PATH\|/test_docs/enum.HeavilyDocumentedEnum.html
	56
	57	assert-css: ("h1.fqn", {"font-size": "24px"})
	58	assert-css: ("h1.fqn", {"border-bottom-width": "1px"})
	59
	60	assert-css: ("h2#top-doc-prose-title", {"font-size": "20.8px"})
	61	assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
	62	assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "18.4px"})
	63	assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
	64	assert-css: ("h4#top-doc-prose-sub-sub-heading", {"font-size": "17.6px"})
65	assert-css: ("h4#top-doc-prose-sub-sub-heading", {"border-bottom-width": "1px"})
66
67	assert-css: ("h2#variants", {"font-size": "22.4px"})
68	assert-css: ("h2#variants", {"border-bottom-width": "1px"})
69
70	assert-css: ("h4#none-prose-title", {"font-size": "16px"})
71	assert-css: ("h4#none-prose-title", {"border-bottom-width": "0px"})
72	assert-css: ("h5#none-prose-sub-heading", {"font-size": "16px"})
73	assert-css: ("h5#none-prose-sub-heading", {"border-bottom-width": "0px"})
74
75	assert-css: ("h4#wrapped-prose-title", {"font-size": "16px"})
76	assert-css: ("h4#wrapped-prose-title", {"border-bottom-width": "0px"})
77	assert-css: ("h5#wrapped-prose-sub-heading", {"font-size": "16px"})
78	assert-css: ("h5#wrapped-prose-sub-heading", {"border-bottom-width": "0px"})
79
80	assert-css: ("h5#wrapped0-prose-title", {"font-size": "16px"})
81	assert-css: ("h5#wrapped0-prose-title", {"border-bottom-width": "0px"})
82	assert-css: ("h6#wrapped0-prose-sub-heading", {"font-size": "15.2px"})
83	assert-css: ("h6#wrapped0-prose-sub-heading", {"border-bottom-width": "0px"})
84
85	assert-css: ("h5#structy-prose-title", {"font-size": "16px"})
86	assert-css: ("h5#structy-prose-title", {"border-bottom-width": "0px"})
87	assert-css: ("h6#structy-prose-sub-heading", {"font-size": "15.2px"})
88	assert-css: ("h6#structy-prose-sub-heading", {"border-bottom-width": "0px"})
89
90	assert-css: ("h2#implementations", {"font-size": "22.4px"})
91	assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
92
93	assert-css: ("#impl > h3.code-header", {"font-size": "17.6px"})
94	assert-css: ("#impl > h3.code-header", {"border-bottom-width": "0px"})
95	assert-css: ("#method\.do_nothing > h4.code-header", {"font-size": "16px"})
96	assert-css: ("#method\.do_nothing > h4.code-header", {"border-bottom-width": "0px"})
97
98	assert-css: ("h4#title-for-enum-impl-doc", {"font-size": "16px"})
99	assert-css: ("h4#title-for-enum-impl-doc", {"border-bottom-width": "0px"})
100	assert-css: ("h5#sub-heading-for-enum-impl-doc", {"font-size": "16px"})
101	assert-css: ("h5#sub-heading-for-enum-impl-doc", {"border-bottom-width": "0px"})
102	assert-css: ("h6#sub-sub-heading-for-enum-impl-doc", {"font-size": "15.2px"})
103	assert-css: ("h6#sub-sub-heading-for-enum-impl-doc", {"border-bottom-width": "0px"})
104
105	assert-css: ("h5#title-for-enum-impl-item-doc", {"font-size": "16px"})
106	assert-css: ("h5#title-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
107	assert-css: ("h6#sub-heading-for-enum-impl-item-doc", {"font-size": "15.2px"})
108	assert-css: ("h6#sub-heading-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
109	assert-css: ("h6#sub-sub-heading-for-enum-impl-item-doc", {"font-size": "15.2px"})
110	assert-css: ("h6#sub-sub-heading-for-enum-impl-item-doc", {"border-bottom-width": "0px"})
111
112	assert-text: (".sidebar .others h3", "Modules")
113	assert-css: (".sidebar .others h3", {"border-bottom-width": "1px"}, ALL)
114
115	goto: file://\|DOC_PATH\|/test_docs/union.HeavilyDocumentedUnion.html
116
117	assert-css: ("h1.fqn", {"font-size": "24px"})
118	assert-css: ("h1.fqn", {"border-bottom-width": "1px"})
119
120	assert-css: ("h2#top-doc-prose-title", {"font-size": "20.8px"})
121	assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
122	assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "18.4px"})
123	assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})
124
125	assert-css: ("h2#fields", {"font-size": "22.4px"})
126	assert-css: ("h2#fields", {"border-bottom-width": "1px"})
127
128	assert-css: ("h3#title-for-union-variant", {"font-size": "20.8px"})
129	assert-css: ("h3#title-for-union-variant", {"border-bottom-width": "0px"})
130	assert-css: ("h4#sub-heading-for-union-variant", {"font-size": "16px"})
131	assert-css: ("h4#sub-heading-for-union-variant", {"border-bottom-width": "0px"})
132
133	assert-css: ("h2#implementations", {"font-size": "22.4px"})
134	assert-css: ("h2#implementations", {"border-bottom-width": "1px"})
135
136	assert-css: ("#impl > h3.code-header", {"font-size": "17.6px"})
137	assert-css: ("#impl > h3.code-header", {"border-bottom-width": "0px"})
138	assert-css: ("h4#title-for-union-impl-doc", {"font-size": "16px"})
139	assert-css: ("h4#title-for-union-impl-doc", {"border-bottom-width": "0px"})
140	assert-css: ("h5#sub-heading-for-union-impl-doc", {"font-size": "16px"})
141	assert-css: ("h5#sub-heading-for-union-impl-doc", {"border-bottom-width": "0px"})
142
143	assert-css: ("h5#title-for-union-impl-item-doc", {"font-size": "16px"})
144	assert-css: ("h5#title-for-union-impl-item-doc", {"border-bottom-width": "0px"})
145	assert-css: ("h6#sub-heading-for-union-impl-item-doc", {"font-size": "15.2px"})
146	assert-css: ("h6#sub-heading-for-union-impl-item-doc", {"border-bottom-width": "0px"})
147
148	goto: file://\|DOC_PATH\|/test_docs/macro.heavily_documented_macro.html
149
150	assert-css: ("h1.fqn", {"font-size": "24px"})
151	assert-css: ("h1.fqn", {"border-bottom-width": "1px"})
152
153	assert-css: ("h2#top-doc-prose-title", {"font-size": "20.8px"})
154	assert-css: ("h2#top-doc-prose-title", {"border-bottom-width": "1px"})
155	assert-css: ("h3#top-doc-prose-sub-heading", {"font-size": "18.4px"})
156	assert-css: ("h3#top-doc-prose-sub-heading", {"border-bottom-width": "1px"})