Skip to content

Commit

Permalink
Bulk refactoring of markup style
Browse files Browse the repository at this point in the history
  • Loading branch information
@marble
marble committed Oct 8, 2020
1 parent 8750014 commit d7e0b6a
Show file tree
Hide file tree
Showing 35 changed files with 1,341 additions and 1,035 deletions.
95 changes: 93 additions & 2 deletions Documentation/Index.rst
View file
Expand Up @@ -8,25 +8,116 @@ Tell Me Something About Topic X
Rendered: |today|

:Title: Tell Me Something About Topic X
:Author: TYPO3 Documentation Team
:Main assignee: Martin Bless <martin.bless@typo3.org>
:Authors: TYPO3 Documentation Team
:Maintainer: Martin Bless <martin.bless@typo3.org>
:Description: Frequently searched topics with explanations and links
:Published at: https://docs.typo3.org/m/typo3/guide-tell-me-something-about/master/en-us/
:Repository: https://github.com/TYPO3-Documentation/TYPO3CMS-TellMeSomethingAbout/
:License: `CC BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__

This manual is part of official TYPO3 documentation.

.. Do not use headlines on this page as we have a .. toctree::
at the end of this page.
--------------------------------------------------

**What is this?**

• intended to be a help for developers to quickly find some interesting
starting points when diving into a topic you are not familiar with
• a collection of short information pointers, structured by topics
• a collection of short information pointers, structured by topics
• a collection of topics that are important in TYPO3 context
• a place to keep search results when doing internet research
• a collection of links to content that somehow sticks out
• a time saver for you - hopefully


.. // http://www.graphviz.org/doc/info/attrs.html
// http://www.graphviz.org/doc/info/attrs.html#k:escString
// http://www.graphviz.org/doc/info/attrs.html#k:shape
// https://en.wikipedia.org/wiki/DOT_(graph_description_language)#General
// https://graphs.grevian.org/example
// https://graphviz.org/doc/info/lang.html
// https://graphviz.org/pdf/dotguide.pdf
// https://manpages.debian.org/testing/graphviz/dot.1.en.html
// https://renenyffenegger.ch/notes/tools/Graphviz/examples/index
.. graphviz::

digraph G {
layout=neato;
node[fontsize=14,style=solid];
SEARCHING [label="Looking for",style=dashed,shape=rectangle];

node[fontsize=12,style=filled];
SEARCHING -> Caching;
SEARCHING -> Fluid;
SEARCHING -> Performance;
SEARCHING -> more_1;
SEARCHING -> more_2;
SEARCHING -> CKEditor;
SEARCHING -> Deployment;


node[fontsize=8,width=.1,height=.1,shape=ellipse,style=filled,fillcolor=white]
Caching -> offdocs_1;
Caching -> blogpostings_1;
Caching -> videos_1;
CKEditor -> CKEditor_whatisit;
CKEditor -> CKEditor_resources;
CKEditor -> CKEditor_blogpostings;
CKEditor -> CKEditor_onlinetryouts;
Deployment -> Deployment_blog_postings;
Deployment -> Deployment_clever_solution;
Deployment -> Deployment_tools;
Fluid -> offdocs_2;
Fluid -> blogpostings_2;
Fluid -> Tools;
Fluid -> Viewhelpers;
Performance -> offdocs_3;
Performance -> blogpostings_3;
Performance -> tutorials_4;
Performance -> Links;

node[label="",shape=circle,width=.1,height=0.1]
Performance -> performance_1;
Caching -> caching_1;
Fluid -> fluid_1;
more_1 -> more_1_1;
more_1 -> more_1_2;
more_1 -> more_1_3;
more_1 -> more_1_4;
more_1 -> more_1_5;
more_1 -> more_1_6;
more_2 -> more_2_1;
more_2 -> more_2_2;
more_2 -> more_2_3;

blogpostings_1 [label="Blog postings"];
blogpostings_2 [label="Blog postings"];
blogpostings_3 [label="Blog postings"];
more_1 [label="Your idea"];
more_2 [label="More..."];
offdocs_1 [label="Official docs",tooltip="Official docs"];
offdocs_2 [label="Official docs",tooltip="Official docs"];
offdocs_3 [label="Official docs",tooltip="Official docs"];
tutorials_4 [label="Tutorials"];
videos_1 [label="Videos"];

CKEditor [href="../Topics/Ckeditor.html",target=_top];
CKEditor_blogpostings [label="Blog postings" ,href="../Topics/Ckeditor.html#blog-postings" ,target=_top,tooltip="Blog postings"];
CKEditor_onlinetryouts [label="Online tryouts",href="../Topics/Ckeditor.html#online-tryouts",target=_top];
CKEditor_whatisit [label="What is it?" ,href="../Topics/Ckeditor.html#description" ,target=_top];
CKEditor_resources [label="Resources" ,href="../Topics/Ckeditor.html#resources" ,target=_top];
Deployment [label="Blog postings",href="../Topics/Deployment.html#blog-postings" ,target=_top,tooltip="Blog postings"];
Deployment [label="Tools",href="../Topics/Deployment.html#tools" ,target=_top,tooltip="Tools"];
Deployment [label="Clever solutions",href="../Topics/Deployment.html#clever-solutions" ,target=_top,tooltip="Clever solutions"];
}


--------------------------------------------------

**What this is NOT**
Expand Down
1 change: 1 addition & 0 deletions Documentation/Linktargets/Index.rst
View file
Expand Up @@ -8,3 +8,4 @@ Linktargets
Targets for Cross-Referencing

.. ref-targets-list::

44 changes: 18 additions & 26 deletions Documentation/Settings.cfg
View file
Expand Up @@ -11,21 +11,6 @@ description = This manual contains lists of topics that are frequently
searched for. The plan is to add explanations and links over the time.


; defaults:
# highlight_language = 'php'
# html_use_smartypants = False
# language = None
# master_doc = 'Index'
# pygments_style = 'sphinx'
# source_suffix = ['.rst', '.md']
# todo_include_todos = False


[notify]

about_new_builds = no


[html_theme_options]

; for theme t3SphinxThemeRtd
Expand Down Expand Up @@ -53,6 +38,24 @@ project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-TellMeSom
use_opensearch =


[extlinks]
# ; Example:
# ; :forge:`12345` will be rendered as
# ; <a href="https://forge.typo3.org/issues/12345">forge:12345</a>
#
# ; name = url | prefix
#
# forge = https://forge.typo3.org/issues/%s | forge:
# review = https://review.typo3.org/%s | review:

t3ext = https://extensions.typo3.org/extension/%s/ | ext:


[exclude_patterns]

anyname1 = ZUMKLAUN*


[intersphinx_mapping]

; in this manual we actually use: none
Expand Down Expand Up @@ -86,14 +89,3 @@ t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/
t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/
# t3tssyntax = https://docs.typo3.org/typo3cms/TyposcriptSyntaxReference/


[extensions]
#
# ; Add to list of extensions[] as defined in 'conf.py'.
# ; Mention the extensions you need. Some are loaded automatically
# ; and don't need to be mentioned. Examples:
#
# any_name_1 = sphinx.ext.extlinks
# any_name_2 = sphinx.ext.ifconfig
# any_name_3 = sphinx.ext.intersphinx
sphinxcontrib_youtube = sphinxcontrib.youtube
143 changes: 84 additions & 59 deletions Documentation/Topics/00ThisCanBeYourNewTopic.rst
View file
Expand Up @@ -6,110 +6,135 @@
THIS CAN BE YOUR NEW TOPIC
========================================================

.. contents::
:local:
:backlinks: top


How to add your new topic
You want to add a topic that is not in the portfolio yet?
=========================

.. attention::
You want to add a topic that is not in the portfolio yet?

Make a copy of this file and give it an appropriate name.
Then start editing the copied file.
.. attention::

.. tip::
Make a copy of this file and give it an appropriate name.
Then start editing the copied file.

Just start somehow. The TYPO3 Documentation Team will give assistance.
.. tip::

Just start somehow. The TYPO3 Documentation Team will give assistance.

__________________________________________________

Description
*Should* always be present first.
===========

__________________________________________________
Would be nice to always have a short description here.

Search
Search for:
✦
`typo3+clever+search <https://www.startpage.com/do/dsearch?query=typo3+clever+search>`__
✦
`typo3+"clever+search" <https://www.startpage.com/do/dsearch?query=typo3+%22clever+search%22>`__
✦

.. use 50 underscores to mark a transition (= hr = horizontal line)
Search
======

__________________________________________________
Search for:
✦
`typo3+clever+search
<https://www.startpage.com/do/dsearch?query=typo3+clever+search>`__
✦
`typo3+"clever+search"
<https://www.startpage.com/do/dsearch?query=typo3+%22clever+search%22>`__
✦

**Add YOUR rubrics as needed.**
.. Make your points here.
Just start somehow.
In general use alphabetical order.
Here are some ideas:
Here are some ideas:
__________________________________________________
My first new headline
=====================

Official documentation
Where is this covered in the official docs?
...

__________________________________________________

Blog postings
...
=============

...

__________________________________________________

Clever solution
...
===============

...

__________________________________________________

Definition
...
==========

...

__________________________________________________

Discussions
...
===========

...

__________________________________________________

Keywords
...
========

...


Links - to be sorted
====================

...

__________________________________________________

Links
...
Official documentation
======================

Where is this covered in the official docs?


See also
========

• Example link to another document. Example: :doc:`00ThisCanBeYourNewTopic`
• ...

__________________________________________________

Slides
...
======

...

__________________________________________________

Techniques
...
==========

__________________________________________________
...

Tools
...

__________________________________________________
Tools
=====

Videos
...
...

__________________________________________________

Whatever
...
✦
...
✦
...
✦
Videos
======

__________________________________________________
...

See also
• Link to a document. Example: :doc:`00ThisCanBeYourNewTopic`
• ...

__________________________________________________
Whatever
========

...
✦
...
✦
...
✦

0 comments on commit d7e0b6a

Please sign in to comment.