Skip to content

Commit 48f4361

Browse files
authored
Upgrade to Docsy 0 7 2 (#1529)
* update to docsy 0.7.2 * do not persist these tabs * remove unnecessary references to langEqualsHeader * remove unnecessary text=true references in tabs * update style page with information on when to use which references in the tabs
1 parent c54b69d commit 48f4361

File tree

135 files changed

+775
-812
lines changed

Some content is hidden

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

135 files changed

+775
-812
lines changed

website_and_docs/content/documentation/_index.en.md

Lines changed: 1 addition & 1 deletion
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 text=true langEqualsHeader=true >}}
34+
{{< tabpane text=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

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

2020

21-
{{< tabpane text=true langEqualsHeader=true >}}
21+
{{< tabpane text=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

Lines changed: 1 addition & 1 deletion
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 text=true langEqualsHeader=true >}}
32+
{{< tabpane text=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

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

2424

2525

26-
{{< tabpane text=true langEqualsHeader=true >}}
26+
{{< tabpane text=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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,7 @@ The Docsy code tabs look like this:
105105
To generate the above tabs, this is what you need to write.
106106
Note that the `tabpane` includes `langEqualsHeader=true`.
107107
This auto-formats the code in each tab to match the header name,
108-
but more importantly it ensures that all tabs on the page with a language
109-
are set to the same thing, so we always want to include it.
108+
and ensures that all tabs on the page with a language are set to the same thing.
110109

111110
{{</* tabpane langEqualsHeader=true */>}}
112111
{{</* tab header="Java" */>}}
@@ -129,7 +128,7 @@ are set to the same thing, so we always want to include it.
129128
{{</* /tab */>}}
130129
{{</* /tabpane */>}}
131130

132-
#### Reference Github Examples
131+
#### Reference GitHub Examples
133132

134133
To ensure that all code is kept up to date, our goal is to write the code in the repo where it
135134
can be executed when Selenium versions are updated to ensure that everything is correct.
@@ -138,19 +137,18 @@ All code examples to be in our
138137
[example directories](https://github.com/SeleniumHQ/seleniumhq.github.io/tree/dev/examples).
139138

140139
This code can be automatically displayed in the documentation using the `gh-codeblock` shortcode.
141-
The shortcode automatically generates its own html, so if any tab is using this shortcode,
142-
set `text=true` in the `tabpane`/`tab` to prevent the auto-formatting, and add `code=true` in any
143-
`tab` that still needs to get formatted with code.
144-
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
145-
Note that the `gh-codeblock` line can not be indented at all.
140+
The shortcode automatically generates its own html, so we do not want it to auto-format with the language header.
141+
If all tabs are using this shortcode, set `text=true` in the `tabpane` and remove `langEqualsHeader=true`.
142+
If only some tabs are using this shortcode, keep `langEqualsHeader=true` in the `tabpane` and add `text=true`
143+
to the `tab`. Note that the `gh-codeblock` line can not be indented at all.
146144

147145
One great thing about using `gh-codeblock` is that it adds a link to the full example.
148146
This means you don't have to include any additional context code, just the line(s) that
149147
are needed, and the user can navigate to the repo to see how to use it.
150148

151149
A basic comparison of code looks like:
152150

153-
{{</* tabpane text=true langEqualsHeader=true */>}}
151+
{{</* tabpane text=true */>}}
154152
{{</* tab header="Java" */>}}
155153
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L46-L47" */>}}
156154
{{</* /tab */>}}
@@ -173,7 +171,7 @@ A basic comparison of code looks like:
173171

174172
Which looks like this:
175173

176-
{{< tabpane text=true langEqualsHeader=true >}}
174+
{{< tabpane text=true >}}
177175
{{< tab header="Java" >}}
178176
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L46-L47" >}}
179177
{{< /tab >}}
@@ -200,7 +198,7 @@ If you want your example to include something other than code (default) or html
200198
you need to first set `text=true`,
201199
then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with curly braces:
202200

203-
{{</* tabpane text=true langEqualsHeader=true */>}}
201+
{{</* tabpane text=true */>}}
204202
{{%/* tab header="Java" */%}}
205203
1. Start the driver
206204
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L17" */>}}
@@ -214,7 +212,7 @@ then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with
214212

215213
This produces:
216214

217-
{{< tabpane text=true langEqualsHeader=true >}}
215+
{{< tabpane text=true >}}
218216
{{% tab header="Java" %}}
219217
1. Start the driver
220218
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L17" >}}

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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,7 @@ The Docsy code tabs look like this:
104104
To generate the above tabs, this is what you need to write.
105105
Note that the `tabpane` includes `langEqualsHeader=true`.
106106
This auto-formats the code in each tab to match the header name,
107-
but more importantly it ensures that all tabs on the page with a language
108-
are set to the same thing, so we always want to include it.
107+
and ensures that all tabs on the page with a language are set to the same thing.
109108

110109
{{</* tabpane langEqualsHeader=true */>}}
111110
{{</* tab header="Java" */>}}
@@ -128,7 +127,7 @@ are set to the same thing, so we always want to include it.
128127
{{</* /tab */>}}
129128
{{</* /tabpane */>}}
130129

131-
#### Reference Github Examples
130+
#### Reference Gitub Examples
132131

133132
To ensure that all code is kept up to date, our goal is to write the code in the repo where it
134133
can be executed when Selenium versions are updated to ensure that everything is correct.
@@ -137,19 +136,18 @@ All code examples to be in our
137136
[example directories](https://github.com/SeleniumHQ/seleniumhq.github.io/tree/dev/examples).
138137

139138
This code can be automatically displayed in the documentation using the `gh-codeblock` shortcode.
140-
The shortcode automatically generates its own html, so if any tab is using this shortcode,
141-
set `text=true` in the `tabpane`/`tab` to prevent the auto-formatting, and add `code=true` in any
142-
`tab` that still needs to get formatted with code.
143-
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
144-
Note that the `gh-codeblock` line can not be indented at all.
139+
The shortcode automatically generates its own html, so we do not want it to auto-format with the language header.
140+
If all tabs are using this shortcode, set `text=true` in the `tabpane` and remove `langEqualsHeader=true`.
141+
If only some tabs are using this shortcode, keep `langEqualsHeader=true` in the `tabpane` and add `text=true`
142+
to the `tab`. Note that the `gh-codeblock` line can not be indented at all.
145143

146144
One great thing about using `gh-codeblock` is that it adds a link to the full example.
147145
This means you don't have to include any additional context code, just the line(s) that
148146
are needed, and the user can navigate to the repo to see how to use it.
149147

150148
A basic comparison of code looks like:
151149

152-
{{</* tabpane text=true langEqualsHeader=true */>}}
150+
{{</* tabpane text=true */>}}
153151
{{</* tab header="Java" */>}}
154152
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L46-L47" */>}}
155153
{{</* /tab */>}}
@@ -172,7 +170,7 @@ A basic comparison of code looks like:
172170

173171
Which looks like this:
174172

175-
{{< tabpane text=true langEqualsHeader=true >}}
173+
{{< tabpane text=true >}}
176174
{{< tab header="Java" >}}
177175
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L46-L47" >}}
178176
{{< /tab >}}
@@ -199,7 +197,7 @@ If you want your example to include something other than code (default) or html
199197
you need to first set `text=true`,
200198
then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with curly braces:
201199

202-
{{</* tabpane text=true langEqualsHeader=true */>}}
200+
{{</* tabpane text=true */>}}
203201
{{%/* tab header="Java" */%}}
204202
1. Start the driver
205203
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L17" */>}}
@@ -213,7 +211,7 @@ then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with
213211

214212
This produces:
215213

216-
{{< tabpane text=true langEqualsHeader=true >}}
214+
{{< tabpane text=true >}}
217215
{{% tab header="Java" %}}
218216
1. Start the driver
219217
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L17" >}}

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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,7 @@ The Docsy code tabs look like this:
104104
To generate the above tabs, this is what you need to write.
105105
Note that the `tabpane` includes `langEqualsHeader=true`.
106106
This auto-formats the code in each tab to match the header name,
107-
but more importantly it ensures that all tabs on the page with a language
108-
are set to the same thing, so we always want to include it.
107+
and ensures that all tabs on the page with a language are set to the same thing.
109108

110109
{{</* tabpane langEqualsHeader=true */>}}
111110
{{</* tab header="Java" */>}}
@@ -128,7 +127,7 @@ are set to the same thing, so we always want to include it.
128127
{{</* /tab */>}}
129128
{{</* /tabpane */>}}
130129

131-
#### Reference Github Examples
130+
#### Reference GitHub Examples
132131

133132
To ensure that all code is kept up to date, our goal is to write the code in the repo where it
134133
can be executed when Selenium versions are updated to ensure that everything is correct.
@@ -137,19 +136,18 @@ All code examples to be in our
137136
[example directories](https://github.com/SeleniumHQ/seleniumhq.github.io/tree/dev/examples).
138137

139138
This code can be automatically displayed in the documentation using the `gh-codeblock` shortcode.
140-
The shortcode automatically generates its own html, so if any tab is using this shortcode,
141-
set `text=true` in the `tabpane`/`tab` to prevent the auto-formatting, and add `code=true` in any
142-
`tab` that still needs to get formatted with code.
143-
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
144-
Note that the `gh-codeblock` line can not be indented at all.
139+
The shortcode automatically generates its own html, so we do not want it to auto-format with the language header.
140+
If all tabs are using this shortcode, set `text=true` in the `tabpane` and remove `langEqualsHeader=true`.
141+
If only some tabs are using this shortcode, keep `langEqualsHeader=true` in the `tabpane` and add `text=true`
142+
to the `tab`. Note that the `gh-codeblock` line can not be indented at all.
145143

146144
One great thing about using `gh-codeblock` is that it adds a link to the full example.
147145
This means you don't have to include any additional context code, just the line(s) that
148146
are needed, and the user can navigate to the repo to see how to use it.
149147

150148
A basic comparison of code looks like:
151149

152-
{{</* tabpane text=true langEqualsHeader=true */>}}
150+
{{</* tabpane text=true */>}}
153151
{{</* tab header="Java" */>}}
154152
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L46-L47" */>}}
155153
{{</* /tab */>}}
@@ -172,7 +170,7 @@ A basic comparison of code looks like:
172170

173171
Which looks like this:
174172

175-
{{< tabpane text=true langEqualsHeader=true >}}
173+
{{< tabpane text=true >}}
176174
{{< tab header="Java" >}}
177175
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L46-L47" >}}
178176
{{< /tab >}}
@@ -199,7 +197,7 @@ If you want your example to include something other than code (default) or html
199197
you need to first set `text=true`,
200198
then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with curly braces:
201199

202-
{{</* tabpane text=true langEqualsHeader=true */>}}
200+
{{</* tabpane text=true */>}}
203201
{{%/* tab header="Java" */%}}
204202
1. Start the driver
205203
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L17" */>}}
@@ -213,7 +211,7 @@ then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with
213211

214212
This produces:
215213

216-
{{< tabpane text=true langEqualsHeader=true >}}
214+
{{< tabpane text=true >}}
217215
{{% tab header="Java" %}}
218216
1. Start the driver
219217
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L17" >}}

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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,7 @@ The Docsy code tabs look like this:
104104
To generate the above tabs, this is what you need to write.
105105
Note that the `tabpane` includes `langEqualsHeader=true`.
106106
This auto-formats the code in each tab to match the header name,
107-
but more importantly it ensures that all tabs on the page with a language
108-
are set to the same thing, so we always want to include it.
107+
and ensures that all tabs on the page with a language are set to the same thing.
109108

110109
{{</* tabpane langEqualsHeader=true */>}}
111110
{{</* tab header="Java" */>}}
@@ -128,7 +127,7 @@ are set to the same thing, so we always want to include it.
128127
{{</* /tab */>}}
129128
{{</* /tabpane */>}}
130129

131-
#### Reference Github Examples
130+
#### Reference GitHub Examples
132131

133132
To ensure that all code is kept up to date, our goal is to write the code in the repo where it
134133
can be executed when Selenium versions are updated to ensure that everything is correct.
@@ -137,19 +136,18 @@ All code examples to be in our
137136
[example directories](https://github.com/SeleniumHQ/seleniumhq.github.io/tree/dev/examples).
138137

139138
This code can be automatically displayed in the documentation using the `gh-codeblock` shortcode.
140-
The shortcode automatically generates its own html, so if any tab is using this shortcode,
141-
set `text=true` in the `tabpane`/`tab` to prevent the auto-formatting, and add `code=true` in any
142-
`tab` that still needs to get formatted with code.
143-
Either way, set `langEqualsHeader=true` to keep the language tabs synchronized throughout the page.
144-
Note that the `gh-codeblock` line can not be indented at all.
139+
The shortcode automatically generates its own html, so we do not want it to auto-format with the language header.
140+
If all tabs are using this shortcode, set `text=true` in the `tabpane` and remove `langEqualsHeader=true`.
141+
If only some tabs are using this shortcode, keep `langEqualsHeader=true` in the `tabpane` and add `text=true`
142+
to the `tab`. Note that the `gh-codeblock` line can not be indented at all.
145143

146144
One great thing about using `gh-codeblock` is that it adds a link to the full example.
147145
This means you don't have to include any additional context code, just the line(s) that
148146
are needed, and the user can navigate to the repo to see how to use it.
149147

150148
A basic comparison of code looks like:
151149

152-
{{</* tabpane text=true langEqualsHeader=true */>}}
150+
{{</* tabpane text=true */>}}
153151
{{</* tab header="Java" */>}}
154152
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L46-L47" */>}}
155153
{{</* /tab */>}}
@@ -172,7 +170,7 @@ A basic comparison of code looks like:
172170

173171
Which looks like this:
174172

175-
{{< tabpane text=true langEqualsHeader=true >}}
173+
{{< tabpane text=true >}}
176174
{{< tab header="Java" >}}
177175
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L46-L47" >}}
178176
{{< /tab >}}
@@ -199,7 +197,7 @@ If you want your example to include something other than code (default) or html
199197
you need to first set `text=true`,
200198
then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with curly braces:
201199

202-
{{</* tabpane text=true langEqualsHeader=true */>}}
200+
{{</* tabpane text=true */>}}
203201
{{%/* tab header="Java" */%}}
204202
1. Start the driver
205203
{{</* gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L17" */>}}
@@ -213,7 +211,7 @@ then change the Hugo syntax for the `tab`to use `%` instead of `<` and `>` with
213211

214212
This produces:
215213

216-
{{< tabpane text=true langEqualsHeader=true >}}
214+
{{< tabpane text=true >}}
217215
{{% tab header="Java" %}}
218216
1. Start the driver
219217
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/getting_started/FirstScript.java#L17" >}}

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

Lines changed: 2 additions & 2 deletions
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 text=true langEqualsHeader=true >}}
34+
{{< tabpane text=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 text=true langEqualsHeader=true >}}
67+
{{< tabpane text=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

Lines changed: 2 additions & 2 deletions
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 text=true langEqualsHeader=true >}}
34+
{{< tabpane text=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 text=true langEqualsHeader=true >}}
67+
{{< tabpane text=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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Felizmente, provavelmente você não precisa aprender a usar os comandos de baix
1717

1818
Movimentos de ponteiro e rolagem da roda permitem que o usuário defina uma duração para a ação, mas às vezes você só precisa esperar um momento entre as ações para que as coisas funcionem corretamente.
1919

20-
{{< tabpane text=true langEqualsHeader=true >}}
20+
{{< tabpane text=true >}}
2121
{{< tab header="Java" >}}
2222
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L21-L28" >}}
2323
{{< /tab >}}
@@ -46,7 +46,7 @@ Um ponto importante a ser observado é que o driver lembra o estado de todos os
4646

4747
Existe um método especial para liberar todas as teclas pressionadas e botões do ponteiro atualmente pressionados. Esse método é implementado de maneira diferente em cada uma das linguagens porque não é executado com o método de execução (perform).
4848

49-
{{< tabpane text=true langEqualsHeader=true >}}
49+
{{< tabpane text=true >}}
5050
{{< tab header="Java" >}}
5151
{{< gh-codeblock path="examples/java/src/test/java/dev/selenium/actions_api/ActionsTest.java#L46" >}}
5252
{{< /tab >}}

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

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

47-
{{< tabpane text=true langEqualsHeader=true >}}
47+
{{< tabpane text=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 text=true langEqualsHeader=true >}}
82+
{{< tabpane text=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)