Skip to content

Commit 0a90672

Browse files
authored
[TASK] [Backport 12.4] Switch Documentation Rendering to PHP (#105) (#106)
* [TASK] Switch Documentation Rendering to PHP You can try out the rendering locally with ``` make docs ``` * Update Documentation/CoreSupport/Tca/Index.rst * Update Documentation/LocalizedContent/Index.rst --------- Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com> (cherry picked from commit 3ec7aaf)
1 parent 7c98e30 commit 0a90672

8 files changed

Lines changed: 61 additions & 69 deletions

File tree

.editorconfig

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,8 @@ trim_trailing_whitespace = true
2323
indent_style = space
2424
indent_size = 4
2525
max_line_length = 80
26+
27+
# Makefile
28+
[{Makefile,**.mk}]
29+
# Use tabs for indentation (Makefiles require tabs)
30+
indent_style = tab
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: test documentation
2+
3+
on: [ push, pull_request ]
4+
5+
jobs:
6+
tests:
7+
name: documentation
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v4
12+
13+
- name: Test if the documentation will render without warnings
14+
run: |
15+
mkdir -p Documentation-GENERATED-temp \
16+
&& docker run --rm --pull always -v $(pwd):/project \
17+
ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
*GENERATED*
2+
/.idea

Documentation/CoreSupport/Tca/Index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ DataHandler commands for localization
185185

186186
Localizing a record can be done by the
187187
:ref:`"localize" command <t3coreapi:tce-command-keywords>` of the
188-
:ref:`DataHandler <datahandler-basics>`. This is the command that is sent
188+
:ref:`DataHandler <t3coreapi:datahandler-basics>`. This is the command that is sent
189189
when you press the translate buttons in :guilabel:`Web > List` or
190190
:guilabel:`Web > Page` for an element.
191191

Documentation/LocalizedContent/Index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ about the records in the default language at all.
134134
.. tip::
135135
For more information on how to add languages and configure their
136136
behaviour in the site configuration, see
137-
:ref:`Adding Languages <sitehandling-addinglanguages>`.
137+
:ref:`Adding Languages <t3coreapi:sitehandling-addingLanguages>`.
138138

139139

140140
.. _localized-content-all-language:
@@ -170,7 +170,7 @@ is valid for all languages.
170170
Localizing inline elements (IRRE)
171171
=================================
172172

173-
When localizing a record with :ref:`inline elements (IRRE) <columns-inline>`,
173+
When localizing a record with :ref:`inline elements (IRRE) <t3tca:columns-inline-introduction>`,
174174
the inline elements will be grayed out and not automatically localized. TYPO3
175175
will display two buttons to help you localize and keep the elements in
176176
sync.

Documentation/Settings.cfg

Lines changed: 0 additions & 66 deletions
This file was deleted.

Documentation/guides.xml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<guides xmlns="https://www.phpdoc.org/guides"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
5+
links-are-relative="true">
6+
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
7+
project-home="https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/"
8+
project-contact="https://typo3.slack.com/archives/C028JEPJL"
9+
project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-FrontendLocalization"
10+
project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-FrontendLocalization/issues"
11+
edit-on-github-branch="12.4"
12+
edit-on-github="TYPO3-Documentation/TYPO3CMS-Guide-FrontendLocalization"
13+
typo3-core-preferred="12.4"
14+
interlink-shortcode="typo3/guide-frontendlocalization"
15+
/>
16+
<project title="Frontend Localization Guide"
17+
release="12.4"
18+
version="12.4"
19+
copyright="since 2012 by the TYPO3 contributors"
20+
/>
21+
</guides>

Makefile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.PHONY: help
2+
help: ## Displays this list of targets with descriptions
3+
@echo "The following commands are available:\n"
4+
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
5+
6+
.PHONY: docs
7+
docs: ## Generate projects documentation (from "Documentation" directory)
8+
mkdir -p Documentation-GENERATED-temp
9+
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
10+
11+
.PHONY: test-docs
12+
test-docs: ## Test the documentation rendering
13+
mkdir -p Documentation-GENERATED-temp
14+
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log

0 commit comments

Comments
 (0)