{"id":14972228,"url":"https://github.com/typo3-cms/styleguide","last_synced_at":"2025-05-15T08:04:12.822Z","repository":{"id":8530868,"uuid":"10148417","full_name":"TYPO3-CMS/styleguide","owner":"TYPO3-CMS","description":"[READ-ONLY] Subtree split of the TYPO3 Core Extension \"styleguide\"","archived":false,"fork":false,"pushed_at":"2025-04-10T14:12:06.000Z","size":5405,"stargazers_count":103,"open_issues_count":10,"forks_count":60,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-04-10T15:50:21.241Z","etag":null,"topics":["bootstrap3","formengine","icons","styleguide","tca","typo3"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TYPO3-CMS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-05-18T23:22:01.000Z","updated_at":"2025-04-10T14:09:59.000Z","dependencies_parsed_at":"2023-10-04T22:38:51.599Z","dependency_job_id":"fffe4a3a-e7c3-43fe-becd-08aa2acd2cee","html_url":"https://github.com/TYPO3-CMS/styleguide","commit_stats":{"total_commits":1261,"total_committers":83,"mean_commits":15.19277108433735,"dds":0.4742268041237113,"last_synced_commit":"a3349fb17a9615cffdd18e1d71a16bb543f21332"},"previous_names":["typo3-cms/styleguide","typo3/styleguide"],"tags_count":90,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-CMS%2Fstyleguide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-CMS%2Fstyleguide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-CMS%2Fstyleguide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TYPO3-CMS%2Fstyleguide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TYPO3-CMS","download_url":"https://codeload.github.com/TYPO3-CMS/styleguide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248868801,"owners_count":21174762,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap3","formengine","icons","styleguide","tca","typo3"],"created_at":"2024-09-24T13:46:35.715Z","updated_at":"2025-04-14T11:21:30.370Z","avatar_url":"https://github.com/TYPO3-CMS.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"TYPO3 CMS Backend Styleguide\n============================\n\n![](Documentation/styleguide_index.png)\n\n\n# What is it?\n\nStyleguide is a TYPO3 extension. It provides a backend module in the\n\"System\" section of the backend. It can create a page tree to show examples.\n\nWhen TYPO3 core adds or deprecates features  covered by this extension, core developers\nstrive to keep it updated, reflecting  these changes.\n\nStyleguide is a reference to show a lot of TYPO3 backend features, often relevant\nfor own extensions:\n\n* A set of snippets showing how to use default backend functionality like\n  tables, buttons, boxes or notifications.\n* A huge set of 'TCA' examples, showing \"all\" features of the backend editing forms.\n\n\n# Usages\n\n* The extension is interesting for **backend extension developers** as a reference\n  to see how casual stuff like buttons and other HTML related things are solved or\n  used in the backend, and to copy+paste solutions. Additionally, the TCA examples\n  is a near-complete show-case of [FormEngine](https://docs.typo3.org/m/typo3/reference-coreapi/10.4/en-us/ApiOverview/FormEngine/Index.html)\n  (editing records in the backend). Developers will see new things they did not\n  know yet. Guaranteed!\n\n* The extension can be interesting for **technical project managers** to get an idea\n  of what the backend editing is capable of out-of-the-box and which parts can be\n  sold to customers without adding expensive implementation burdens to developers.\n\n* Styleguide is used by **core developers** to test and verify changes to JavaScript, HTML\n  and PHP code do not break layout or functionality of backend modules. The extension\n  is also used in core backend acceptance tests to verify FormEngine details do not\n  break when developing core patches.\n\n* Styleguide is used within the official core documentation to provide examples, screenshots\n  and possible usages of core functionality. Especially the [TCA reference](https://docs.typo3.org/m/typo3/reference-tca/master/en-us/)\n  heavily relies on it.\n\n# Installation\n\nStyleguide comes as a TYPO3 extension for the TYPO3 backend. After initial installation, it is\nadvisable  to let styleguide create an example page tree with records by clicking the\n\"TCA / records -\u003e Create styleguide page tree with data\", and waiting for a couple of\nseconds for the system to crunch the data.\n\n# Initialization\n\nWith styleguide, it is possible to automatically create sample pages and content for 2 purposes:\n\n1. \"styleguide TCA demo\" to showcase various TCA features\n2. \"styleguide frontend demo\" to create pages which can be used for Frontend testing\n\nThese pages can be created either in the backend or on the command line:\n\n```\n# show help\nbin/typo3 styleguide:generate -h\n\n# create pages\nbin/typo3 styleguide:generate -c\n```\n\nAlternatively, the pages can be created in the TYPO3 backend:\n\n1. Access the styleguide module by clicking on the question mark in the top bar:\n   ? | Styleguide | TCA / Records / Frontend\n2. Click the available buttons\n\n# Usage\n\nStyleguide comes with a module which is available by clicking on the question mark in the top bar:\n? | Styleguide.\n\nYou can also peruse through the TCA demo by selecting the pages in the page tree. Use the list module to\nget access to the records.\n\nThe TYPO3 TCA reference documentation often uses examples from the styleguide.\n\n# Legal\n\nThis project is released under GPLv2 license. See LICENSE.txt for details.\n\n* Placeholder texts are from [Bacon Ipsum](http://baconipsum.com/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypo3-cms%2Fstyleguide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypo3-cms%2Fstyleguide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypo3-cms%2Fstyleguide/lists"}