Skip to content

Commit 2e303e9

Browse files
committed
Removing custom tabpane and using Docsy's
[deploy site]
1 parent c825c0b commit 2e303e9

File tree

86 files changed

+717
-840
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+717
-840
lines changed

website_and_docs/content/documentation/_index.en.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ an interface to write instruction sets that can be run interchangeably in many
3131
browsers. Once you've installed everything, only a few lines of code get you inside
3232
a browser. You can find a more comprehensive example in [Writing your first Selenium script]({{< ref "first_script.md" >}})
3333

34-
{{< tabpane code=false langEqualsHeader=true >}}
34+
{{< tabpane text=true langEqualsHeader=true >}}
3535
{{< tab header="Java" >}}
3636
{{< gh-codeblock path="/examples/java/src/test/java/dev/selenium/hello/HelloSelenium.java" >}}
3737
{{< /tab >}}

website_and_docs/content/documentation/_index.ja.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Seleniumの中核は[WebDriver]({{< ref "/webdriver.md" >}})であり、様々
1818
インストラクションの一つです:
1919

2020

21-
{{< tabpane code=false langEqualsHeader=true >}}
21+
{{< tabpane text=true langEqualsHeader=true >}}
2222
{{< tab header="Java" >}}
2323
{{< gh-codeblock path="/examples/java/src/test/java/dev/selenium/hello/HelloSelenium.java" >}}
2424
{{< /tab >}}

website_and_docs/content/documentation/_index.pt-br.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ uma interface para escrever conjuntos de instruções que podem ser executados a
2929
navegadores. Aqui está uma das instruções mais simples que você pode fazer:
3030

3131

32-
{{< tabpane code=false langEqualsHeader=true >}}
32+
{{< tabpane text=true langEqualsHeader=true >}}
3333
{{< tab header="Java" >}}
3434
{{< gh-codeblock path="/examples/java/src/test/java/dev/selenium/hello/HelloSelenium.java" >}}
3535
{{< /tab >}}

website_and_docs/content/documentation/_index.zh-cn.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Selenium 的核心是 [WebDriver]({{< ref "/webdriver.md" >}}),这是一个编
2323

2424

2525

26-
{{< tabpane code=false langEqualsHeader=true >}}
26+
{{< tabpane text=true langEqualsHeader=true >}}
2727
{{< tab header="Java" >}}
2828
{{< gh-codeblock path="/examples/java/src/test/java/dev/selenium/hello/HelloSelenium.java" >}}
2929
{{< /tab >}}

website_and_docs/content/documentation/about/style.en.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ All code examples to be in our
163163

164164
This code can be automatically displayed in the documentation using the `gh-codeblock` shortcode.
165165
The shortcode automatically generates its own html, so if any tab is using this shortcode,
166-
set `code=false` in the `tabpane` to prevent the auto-formatting, and add `code=true` in any
166+
set `text=true` in the `tabpane`/`tab` to prevent the auto-formatting, and add `code=true` in any
167167
`tab` that still needs to get formatted with code.
168168
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
169169
Note that the `gh-codeblock` line can not be indented at all.
@@ -174,7 +174,7 @@ are needed, and the user can navigate to the repo to see how to use it.
174174

175175
A basic comparison of code looks like:
176176

177-
{{</* tabpane code=false langEqualsHeader=true */>}}
177+
{{</* tabpane text=true langEqualsHeader=true */>}}
178178
{{</* tab header="Java" */>}}
179179
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L46-L47" */>}}
180180
{{</* /tab */>}}
@@ -197,7 +197,7 @@ A basic comparison of code looks like:
197197

198198
Which looks like this:
199199

200-
{{< tabpane code=false langEqualsHeader=true >}}
200+
{{< tabpane text=true langEqualsHeader=true >}}
201201
{{< tab header="Java" >}}
202202
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L46-L47" >}}
203203
{{< /tab >}}
@@ -221,10 +221,10 @@ Which looks like this:
221221
### Using Markdown in a Tab
222222

223223
If you want your example to include something other than code (default) or html (from `gh-codeblock`),
224-
you need to first set `code=false`,
224+
you need to first set `text=true`,
225225
then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with curly braces:
226226

227-
{{</* tabpane code=false langEqualsHeader=true */>}}
227+
{{</* tabpane text=true langEqualsHeader=true */>}}
228228
{{%/* tab header="Java" */%}}
229229
1. Start the driver
230230
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L17" */>}}
@@ -238,7 +238,7 @@ then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with
238238

239239
This produces:
240240

241-
{{< tabpane code=false langEqualsHeader=true >}}
241+
{{< tabpane text=true langEqualsHeader=true >}}
242242
{{% tab header="Java" %}}
243243
1. Start the driver
244244
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L17" >}}

website_and_docs/content/documentation/about/style.ja.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Style guide for Selenium documentation"
33
linkTitle: "Style"
44
weight: 6
5-
requiresTranslation: true
65
description: >-
76
Conventions for contributions to the Selenium documentation and code examples
87
---
@@ -129,8 +128,9 @@ The Docsy code tabs look like this:
129128

130129
To generate the above tabs, this is what you need to write.
131130
Note that the `tabpane` includes `langEqualsHeader=true`.
132-
This auto-formats the code in each tab to match the header name
133-
and is also used to synchronize the tabs on the page.
131+
This auto-formats the code in each tab to match the header name,
132+
but more importantly it ensures that all tabs on the page with a language
133+
are set to the same thing, so we always want to include it.
134134

135135
{{</* tabpane langEqualsHeader=true */>}}
136136
{{</* tab header="Java" */>}}
@@ -163,9 +163,9 @@ All code examples to be in our
163163

164164
This code can be automatically displayed in the documentation using the `gh-codeblock` shortcode.
165165
The shortcode automatically generates its own html, so if any tab is using this shortcode,
166-
set `code=false` in the `tabpane` to prevent the auto-formatting, and add `code=true` in any
167-
`tab` that still needs to get formatted with code.
168-
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
166+
set `text=true` in the `tabpane`/`tab` to prevent the auto-formatting, and add `code=true` in any
167+
`tab` that still needs to get formatted with code.
168+
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
169169
Note that the `gh-codeblock` line can not be indented at all.
170170

171171
One great thing about using `gh-codeblock` is that it adds a link to the full example.
@@ -174,7 +174,7 @@ are needed, and the user can navigate to the repo to see how to use it.
174174

175175
A basic comparison of code looks like:
176176

177-
{{</* tabpane code=false langEqualsHeader=true */>}}
177+
{{</* tabpane text=true langEqualsHeader=true */>}}
178178
{{</* tab header="Java" */>}}
179179
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L46-L47" */>}}
180180
{{</* /tab */>}}
@@ -197,7 +197,7 @@ A basic comparison of code looks like:
197197

198198
Which looks like this:
199199

200-
{{< tabpane code=false langEqualsHeader=true >}}
200+
{{< tabpane text=true langEqualsHeader=true >}}
201201
{{< tab header="Java" >}}
202202
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L46-L47" >}}
203203
{{< /tab >}}
@@ -221,10 +221,10 @@ Which looks like this:
221221
### Using Markdown in a Tab
222222

223223
If you want your example to include something other than code (default) or html (from `gh-codeblock`),
224-
you need to first set `code=false`,
224+
you need to first set `text=true`,
225225
then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with curly braces:
226226

227-
{{</* tabpane code=false langEqualsHeader=true */>}}
227+
{{</* tabpane text=true langEqualsHeader=true */>}}
228228
{{%/* tab header="Java" */%}}
229229
1. Start the driver
230230
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L17" */>}}
@@ -238,7 +238,7 @@ then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with
238238

239239
This produces:
240240

241-
{{< tabpane code=false langEqualsHeader=true >}}
241+
{{< tabpane text=true langEqualsHeader=true >}}
242242
{{% tab header="Java" %}}
243243
1. Start the driver
244244
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L17" >}}

website_and_docs/content/documentation/about/style.pt-br.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Style guide for Selenium documentation"
33
linkTitle: "Style"
44
weight: 6
5-
requiresTranslation: true
65
description: >-
76
Conventions for contributions to the Selenium documentation and code examples
87
---
@@ -129,8 +128,9 @@ The Docsy code tabs look like this:
129128

130129
To generate the above tabs, this is what you need to write.
131130
Note that the `tabpane` includes `langEqualsHeader=true`.
132-
This auto-formats the code in each tab to match the header name
133-
and is also used to synchronize the tabs on the page.
131+
This auto-formats the code in each tab to match the header name,
132+
but more importantly it ensures that all tabs on the page with a language
133+
are set to the same thing, so we always want to include it.
134134

135135
{{</* tabpane langEqualsHeader=true */>}}
136136
{{</* tab header="Java" */>}}
@@ -163,9 +163,9 @@ All code examples to be in our
163163

164164
This code can be automatically displayed in the documentation using the `gh-codeblock` shortcode.
165165
The shortcode automatically generates its own html, so if any tab is using this shortcode,
166-
set `code=false` in the `tabpane` to prevent the auto-formatting, and add `code=true` in any
167-
`tab` that still needs to get formatted with code.
168-
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
166+
set `text=true` in the `tabpane`/`tab` to prevent the auto-formatting, and add `code=true` in any
167+
`tab` that still needs to get formatted with code.
168+
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
169169
Note that the `gh-codeblock` line can not be indented at all.
170170

171171
One great thing about using `gh-codeblock` is that it adds a link to the full example.
@@ -174,7 +174,7 @@ are needed, and the user can navigate to the repo to see how to use it.
174174

175175
A basic comparison of code looks like:
176176

177-
{{</* tabpane code=false langEqualsHeader=true */>}}
177+
{{</* tabpane text=true langEqualsHeader=true */>}}
178178
{{</* tab header="Java" */>}}
179179
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L46-L47" */>}}
180180
{{</* /tab */>}}
@@ -197,7 +197,7 @@ A basic comparison of code looks like:
197197

198198
Which looks like this:
199199

200-
{{< tabpane code=false langEqualsHeader=true >}}
200+
{{< tabpane text=true langEqualsHeader=true >}}
201201
{{< tab header="Java" >}}
202202
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L46-L47" >}}
203203
{{< /tab >}}
@@ -221,10 +221,10 @@ Which looks like this:
221221
### Using Markdown in a Tab
222222

223223
If you want your example to include something other than code (default) or html (from `gh-codeblock`),
224-
you need to first set `code=false`,
224+
you need to first set `text=true`,
225225
then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with curly braces:
226226

227-
{{</* tabpane code=false */>}}
227+
{{</* tabpane text=true langEqualsHeader=true */>}}
228228
{{%/* tab header="Java" */%}}
229229
1. Start the driver
230230
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L17" */>}}
@@ -238,7 +238,7 @@ then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with
238238

239239
This produces:
240240

241-
{{< tabpane code=false langEqualsHeader=true >}}
241+
{{< tabpane text=true langEqualsHeader=true >}}
242242
{{% tab header="Java" %}}
243243
1. Start the driver
244244
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L17" >}}

website_and_docs/content/documentation/about/style.zh-cn.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
title: "Style guide for Selenium documentation"
33
linkTitle: "Style"
44
weight: 6
5-
requiresTranslation: true
65
description: >-
76
Conventions for contributions to the Selenium documentation and code examples
87
---
@@ -129,8 +128,9 @@ The Docsy code tabs look like this:
129128

130129
To generate the above tabs, this is what you need to write.
131130
Note that the `tabpane` includes `langEqualsHeader=true`.
132-
This auto-formats the code in each tab to match the header name
133-
and is also used to synchronize the tabs on the page.
131+
This auto-formats the code in each tab to match the header name,
132+
but more importantly it ensures that all tabs on the page with a language
133+
are set to the same thing, so we always want to include it.
134134

135135
{{</* tabpane langEqualsHeader=true */>}}
136136
{{</* tab header="Java" */>}}
@@ -163,9 +163,9 @@ All code examples to be in our
163163

164164
This code can be automatically displayed in the documentation using the `gh-codeblock` shortcode.
165165
The shortcode automatically generates its own html, so if any tab is using this shortcode,
166-
set `code=false` in the `tabpane` to prevent the auto-formatting, and add `code=true` in any
167-
`tab` that still needs to get formatted with code.
168-
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
166+
set `text=true` in the `tabpane`/`tab` to prevent the auto-formatting, and add `code=true` in any
167+
`tab` that still needs to get formatted with code.
168+
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
169169
Note that the `gh-codeblock` line can not be indented at all.
170170

171171
One great thing about using `gh-codeblock` is that it adds a link to the full example.
@@ -174,7 +174,7 @@ are needed, and the user can navigate to the repo to see how to use it.
174174

175175
A basic comparison of code looks like:
176176

177-
{{</* tabpane code=false langEqualsHeader=true */>}}
177+
{{</* tabpane text=true langEqualsHeader=true */>}}
178178
{{</* tab header="Java" */>}}
179179
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L46-L47" */>}}
180180
{{</* /tab */>}}
@@ -197,7 +197,7 @@ A basic comparison of code looks like:
197197

198198
Which looks like this:
199199

200-
{{< tabpane code=false langEqualsHeader=true >}}
200+
{{< tabpane text=true langEqualsHeader=true >}}
201201
{{< tab header="Java" >}}
202202
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L46-L47" >}}
203203
{{< /tab >}}
@@ -221,10 +221,10 @@ Which looks like this:
221221
### Using Markdown in a Tab
222222

223223
If you want your example to include something other than code (default) or html (from `gh-codeblock`),
224-
you need to first set `code=false`,
224+
you need to first set `text=true`,
225225
then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with curly braces:
226226

227-
{{</* tabpane code=false */>}}
227+
{{</* tabpane text=true langEqualsHeader=true */>}}
228228
{{%/* tab header="Java" */%}}
229229
1. Start the driver
230230
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L17" */>}}
@@ -238,7 +238,7 @@ then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with
238238

239239
This produces:
240240

241-
{{< tabpane code=false langEqualsHeader=true >}}
241+
{{< tabpane text=true langEqualsHeader=true >}}
242242
{{% tab header="Java" %}}
243243
1. Start the driver
244244
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScriptTest.java#L17" >}}

website_and_docs/content/documentation/webdriver/actions_api/_index.en.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ lower level commands for you. These are all documented in
3131
Pointer movements and Wheel scrolling allow the user to set a duration for the action, but sometimes you just need
3232
to wait a beat between actions for things to work correctly.
3333

34-
{{< tabpane code=false langEqualsHeader=true >}}
34+
{{< tabpane text=true langEqualsHeader=true >}}
3535
{{< tab header="Java" >}}
3636
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L21-L28" >}}
3737
{{< /tab >}}
@@ -64,7 +64,7 @@ There is a special method to release all currently depressed keys and pointer bu
6464
This method is implemented differently in each of the languages because
6565
it does not get executed with the perform method.
6666

67-
{{< tabpane code=false langEqualsHeader=true >}}
67+
{{< tabpane text=true langEqualsHeader=true >}}
6868
{{< tab header="Java" >}}
6969
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L46" >}}
7070
{{< /tab >}}

website_and_docs/content/documentation/webdriver/actions_api/_index.ja.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ lower level commands for you. These are all documented in
3131
Pointer movements and Wheel scrolling allow the user to set a duration for the action, but sometimes you just need
3232
to wait a beat between actions for things to work correctly.
3333

34-
{{< tabpane code=false langEqualsHeader=true >}}
34+
{{< tabpane text=true langEqualsHeader=true >}}
3535
{{< tab header="Java" >}}
3636
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L21-L28" >}}
3737
{{< /tab >}}
@@ -64,7 +64,7 @@ There is a special method to release all currently depressed keys and pointer bu
6464
This method is implemented differently in each of the languages because
6565
it does not get executed with the perform method.
6666

67-
{{< tabpane code=false langEqualsHeader=true >}}
67+
{{< tabpane text=true langEqualsHeader=true >}}
6868
{{< tab header="Java" >}}
6969
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L46" >}}
7070
{{< /tab >}}

website_and_docs/content/documentation/webdriver/actions_api/_index.pt-br.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ lower level commands for you. These are all documented in
3131
Pointer movements and Wheel scrolling allow the user to set a duration for the action, but sometimes you just need
3232
to wait a beat between actions for things to work correctly.
3333

34-
{{< tabpane code=false langEqualsHeader=true >}}
34+
{{< tabpane text=true langEqualsHeader=true >}}
3535
{{< tab header="Java" >}}
3636
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L21-L28" >}}
3737
{{< /tab >}}
@@ -64,7 +64,7 @@ There is a special method to release all currently depressed keys and pointer bu
6464
This method is implemented differently in each of the languages because
6565
it does not get executed with the perform method.
6666

67-
{{< tabpane code=false langEqualsHeader=true >}}
67+
{{< tabpane text=true langEqualsHeader=true >}}
6868
{{< tab header="Java" >}}
6969
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L46" >}}
7070
{{< /tab >}}

website_and_docs/content/documentation/webdriver/actions_api/_index.zh-cn.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Selenium允许您构建分配给特定输入的独立操作命令,
4444
但有时您只需要在操作之间等待一下,
4545
即可正常工作.
4646

47-
{{< tabpane code=false langEqualsHeader=true >}}
47+
{{< tabpane text=true langEqualsHeader=true >}}
4848
{{< tab header="Java" >}}
4949
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L21-L28" >}}
5050
{{< /tab >}}
@@ -79,7 +79,7 @@ Selenium允许您构建分配给特定输入的独立操作命令,
7979
此方法在每种语言中的实现方式不同,
8080
因为它不会使用perform方法执行.
8181

82-
{{< tabpane code=false langEqualsHeader=true >}}
82+
{{< tabpane text=true langEqualsHeader=true >}}
8383
{{< tab header="Java" >}}
8484
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L46" >}}
8585
{{< /tab >}}

0 commit comments

Comments
 (0)