Skip to content

Commit 68e965f

Browse files
linawolflinawolf
authored
[TASK] Disable Language Switch if needed (#759)
Resolves #758
1 parent 5e8aa57 commit 68e965f

File tree

5 files changed

+248
-1
lines changed

5 files changed

+248
-1
lines changed

‎packages/typo3-docs-theme/resources/template/structure/navigation/navigationHeader.html.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
{% endif -%}
99
{%- endfor -%}
1010

11-
{% if env.projectNode.version -%}
11+
{% if env.projectNode.version and not getSettings('disable_version_switch') -%}
1212
<div class="toc-version-wrapper" id="toc-version-wrapper">
1313
{% if isRenderedForDeployment() -%}
1414
<div id="toc-version" class="toc-version">

‎packages/typo3-docs-theme/src/DependencyInjection/Typo3DocsThemeExtension.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ public function load(array $configs, ContainerBuilder $container): void
6666
'report_issue' => $this->getConfigValue($configs, 'report_issue', ''),
6767
'typo3_core_preferred' => $this->getConfigValue($configs, 'typo3_core_preferred', ''),
6868
'confval_default' => $this->getConfigValue($configs, 'confval_default', 'Option'),
69+
'disable_version_switch' => $this->getConfigValue($configs, 'disable_version_switch', ''),
6970
],
7071
],
7172
);

‎tests/Integration/tests-full/disabled-version-switch/expected/index.html

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
<!DOCTYPE html>
2+
<html class="no-js" lang="en">
3+
<head>
4+
<title>Some page — Test main documentation</title>
5+
6+
7+
<meta charset="utf-8">
8+
<meta content="width=device-width, initial-scale=1.0" name="viewport">
9+
<meta content="phpdocumentor/guides" name="generator">
10+
<meta content="Test" name="docsearch:name">
11+
<meta content="" name="docsearch:package_type">
12+
<meta content="main" name="docsearch:release">
13+
<meta content="main" name="docsearch:version">
14+
<meta content="2023-01-01T12:00:00+00:00" name="docsearch:modified">
15+
<meta content="2023-01-01T12:00:00+00:00" name="dc.modified">
16+
<meta content="2023-01-01T12:00:00+00:00" property="article:modified_time">
17+
<link href="http://purl.org/dc/elements/1.1/" rel="schema.dc">
18+
<link href="_resources/css/theme.css" rel="stylesheet">
19+
<link href="https://docs.typo3.org/search/" rel="search" title="Search">
20+
<script src="https://typo3.azureedge.net/typo3infrastructure/universe/dist/webcomponents-loader.js"></script>
21+
<script src="https://typo3.azureedge.net/typo3infrastructure/universe/dist/typo3-universe.js" type="module"></script>
22+
<link href="#" rel="top" title="Some page"/>
23+
</head>
24+
<body>
25+
<div class="page">
26+
27+
<header>
28+
<div class="page-topbar">
29+
<div class="page-topbar-inner">
30+
<typo3-universe active="documentation">
31+
<div style="display: block; height: 44px; background-color: #313131;"></div>
32+
</typo3-universe>
33+
</div>
34+
</div>
35+
<div class="page-header">
36+
<div class="page-header-inner">
37+
<div class="row">
38+
<div class="col-sm-3 col-md-4 col-lg-6">
39+
<a class="logo" href="https://docs.typo3.org/" title="TYPO3 Documentation">
40+
<img alt="TYPO3 Logo" class="logo-image" src="_resources/img/typo3-logo.svg" width="484" height="130">
41+
</a>
42+
</div>
43+
<div class="col-sm-9 col-md-8 col-lg-6">
44+
<search role="search">
45+
<form action="https://docs.typo3.org/search/search" id="global-search-form" method="get">
46+
<div class="sr-only"><label for="globalsearchinput">TYPO3 documentation...</label></div>
47+
<div class="input-group mb-3 mt-sm-3">
48+
<select class="form-select search__scope" id="searchscope" name="scope">
49+
<option value="">Search all</option>
50+
</select>
51+
<input autocomplete="off" class="form-control shadow-none" id="globalsearchinput" name="q" placeholder="TYPO3 documentation..." type="text" value="">
52+
<button class="btn btn-light search__submit" type="submit"><i class="fa fa-search"></i>&nbsp;<span class="d-none d-md-inline">Search</span></button>
53+
</div>
54+
</form>
55+
</search>
56+
</div>
57+
</div>
58+
</div>
59+
</div>
60+
</header> <main class="page-main">
61+
<div class="page-main-inner">
62+
<div class="page-main-navigation">
63+
<nav>
64+
<input class="toc-checkbox" id="toggleToc" type="checkbox">
65+
66+
67+
<div class="toc-header">
68+
<div class="toc-title">
69+
<a class="toc-title-project" href="#">Test</a>
70+
</div>
71+
<div class="toc-actions">
72+
<label class="toc-toggle" for="toggleToc">
73+
Menu
74+
</label>
75+
</div>
76+
</div> <div class="toc-collapse">
77+
<div aria-label="main navigation" class="toc" role="navigation">
78+
<div aria-label="Main navigation" class="main_menu" role="navigation">
79+
80+
</div>
81+
<div aria-label="Meta navigation" class="main_menu d-block d-lg-none" role="navigation">
82+
<hr/>
83+
<p class="caption">Contributors Corner</p>
84+
<ul class="menu-level-1"> <li><a href="_sources/index.rst.txt" rel="nofollow noopener" target="_blank">
85+
View source of current document
86+
</a></li>
87+
<li><a href="https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingDocsOfficial/GithubMethod.html" rel="nofollow noopener" target="_blank">
88+
How to edit
89+
</a></li>
90+
</ul>
91+
</div>
92+
</div>
93+
</div>
94+
</nav>
95+
</div>
96+
<div class="page-main-content">
97+
<div class="rst-content"> <nav aria-label="breadcrumbs navigation" class="breadcrumb-bar" role="navigation">
98+
99+
<ol class="breadcrumb">
100+
<li aria-current="page" class="breadcrumb-item active">Some page</li>
101+
</ol>
102+
<div class="breadcrumb-additions"> <a class="btn btn-sm btn-light" href="_sources/index.rst.txt" rel="nofollow noopener" target="_blank">
103+
<span class="btn-icon"><span class="fas fa-code"></span></span>
104+
<span class="btn-text">View source</span>
105+
</a>
106+
<a class="btn btn-sm btn-light" href="https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingDocsOfficial/GithubMethod.html" id="btnHowToEdit" rel="nofollow noopener" target="_blank">
107+
<span class="btn-icon"><span class="fas fa-info-circle"></span></span>
108+
<span class="btn-text">How to edit</span>
109+
</a>
110+
</div> </nav>
111+
112+
<article class="document" itemscope="itemscope" itemtype="http://schema.org/Article" role="main">
113+
<div itemprop="articleBody">
114+
<!-- content start -->
115+
<section class="section" id="some-page" data-rst-anchor="references">
116+
<a id="references"></a>
117+
<a id="start"></a>
118+
<h1>Some page<a class="headerlink" href="#some-page" data-bs-toggle="modal" data-bs-target="#linkReferenceModal" title="Reference this headline"><i class="fa-solid fa-paragraph"></i></a></h1>
119+
120+
<p>Lorem Ipsum Dolor.</p>
121+
122+
</section>
123+
<!-- content end -->
124+
</div>
125+
</article>
126+
127+
</div>
128+
</div>
129+
</div>
130+
</main>
131+
132+
<div class="modal fade" id="linkReferenceModal" tabindex="-1" aria-labelledby="linkReferenceModalLabel"
133+
aria-hidden="true" data-current-filename="index">
134+
<div class="modal-dialog">
135+
<div class="modal-content">
136+
<div class="modal-header">
137+
<h5 class="modal-title" id="linkReferenceModalLabel">Reference to the headline</h5>
138+
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
139+
</div>
140+
<div class="modal-body">
141+
<div class="alert alert-success d-none" id="permalink-alert-success" role="alert"></div>
142+
<div class="mb-3">
143+
<label for="permalink-uri" class="col-form-label">Permalink</label>
144+
<div class="input-group">
145+
<input class="form-control code" id="permalink-uri" readonly>
146+
<button type="button" class="btn btn-outline-secondary copy-button" data-target="permalink-uri"><i class="far fa-clone"></i></button>
147+
</div>
148+
<p>Copy and freely share the link</p>
149+
</div>
150+
<div class="mb-3">
151+
<div class="alert alert-warning alert-permalink-rst" role="alert">This link target has no permanent anchor assigned.The link below can be used, but is prone to change if the page gets moved.
152+
</div>
153+
<label for="permalink-rst" class="col-form-label">reStructuredText (reST):</label>
154+
<div class="input-group">
155+
<textarea class="form-control code" id="permalink-rst" readonly></textarea>
156+
<button type="button" class="btn btn-outline-secondary copy-button" data-target="permalink-rst"><i class="far fa-clone"></i></button>
157+
</div>
158+
<p>Copy this link into your TYPO3 manual. </p>
159+
</div>
160+
<div class="mb-3">
161+
<label for="permalink-html" class="col-form-label">HTML:</label>
162+
<div class="input-group">
163+
<textarea class="form-control code" id="permalink-html" readonly></textarea>
164+
<button type="button" class="btn btn-outline-secondary copy-button" data-target="permalink-html"><i class="far fa-clone"></i></button>
165+
</div>
166+
</div>
167+
</div>
168+
<div class="modal-footer">
169+
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
170+
</div>
171+
</div>
172+
</div>
173+
</div> <div class="modal fade" id="generalModal" tabindex="-1" aria-labelledby="linkReferenceModalLabel"
174+
aria-hidden="true" data-current-filename="index"
175+
>
176+
<div class="modal-dialog">
177+
<div class="modal-content">
178+
<div class="modal-header">
179+
<h5 class="modal-title" id="generalModalLabel"></h5>
180+
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
181+
</div>
182+
<div class="modal-body">
183+
<div class="alert alert-success d-none" id="general-alert-success" role="alert"></div>
184+
<div id="generalModalContent">
185+
</div>
186+
</div>
187+
<div class="modal-footer justify-content-between">
188+
<div id="generalModalCustomButtons"></div>
189+
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal"><i class="fa-regular fa-circle-xmark"></i>&nbsp;Close</button>
190+
</div>
191+
</div>
192+
</div>
193+
</div></div>
194+
195+
196+
<footer class="page-footer">
197+
<div class="frame frame-ruler-before frame-background-dark">
198+
<div class="frame-container">
199+
<div class="frame-inner">
200+
<div class="footer-additional">
201+
<p class="text-center">Last rendered: Jan 01, 2023 12:00</p>
202+
</div>
203+
<div class="footer-meta">
204+
<div class="footer-meta-copyright">
205+
&copy; since 1997 by the TYPO3 contributors
206+
</div>
207+
<ul class="footer-meta-navigation">
208+
<li><a href="https://typo3.org/legal-notice" rel="nofollow" target="_blank" title="Legal Notice">Legal Notice</a></li>
209+
<li><a href="https://typo3.org/privacy-policy" rel="nofollow" target="_blank" title="Privacy Policy">Privacy Policy</a></li>
210+
</ul>
211+
</div>
212+
</div>
213+
</div>
214+
</div>
215+
</footer>
216+
<script src="_resources/js/popper.min.js"></script>
217+
<script src="_resources/js/bootstrap.min.js"></script>
218+
<script src="_resources/js/theme.min.js"></script>
219+
220+
<!--
221+
Locally rendered. No tracking embedded.
222+
-->
223+
</body>
224+
</html>

‎tests/Integration/tests-full/disabled-version-switch/input/guides.xml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<guides xmlns="https://www.phpdoc.org/guides" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
4+
>
5+
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
6+
disable-version-switch="true"
7+
/>
8+
9+
<project title="Test"
10+
release="main"
11+
version="main"
12+
copyright="since 1997 by the TYPO3 contributors"
13+
/>
14+
</guides>

‎tests/Integration/tests-full/disabled-version-switch/input/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _start:
2+
.. _references:
3+
4+
=========
5+
Some page
6+
=========
7+
8+
Lorem Ipsum Dolor.

0 commit comments

Comments
 (0)