textpattern.github.io
textpattern.github.io copied to clipboard
page: Index2
Development link... https://docs.textpattern.com/index2
Future link... https://docs.textpattern.com
For reference... https://github.com/orgs/textpattern/teams/documentation-team/discussions/18
That is all for now.
@Bloke It occurs to me that a good use of an include in user docs, however it might work, would be in the relationship between directory index files and the homepage. An include file would thus auto-fill the unordered lists in both of the other files, accordingly, preventing us having to maintain links in those files separately but simultaneously.
{setup_include}
|__ setup/index.md
|__ index.md
And the include would hold the part making up the two section lists:
<section>
#### Basics
* [Installing the software](/setup/installing-the-software)
* [Upgrading the installation](/setup/upgrading-the-installation)
* [Moving an installation](/setup/moving-an-installation)
* [Multi-site installations](/setup/multi-site-installations)
* [Collaborative roles and rights](/setup/collaborative-roles-and-rights){: style="color:red;"} [ties together users panel, roles…]
{:.list--no-bullets style="list-style-position:inside; list-style-type:'- '"}
</section>
<section>
#### More
* [Web server configuration](/setup/configuring-a-web-server-for-textpattern)
* [Troubleshooting common problems](/setup/troubleshooting-common-problems)
* [System security](/setup/system-security)
{:.list--no-bullets style="list-style-position:inside; list-style-type:'- '"}
</section>
Then we only ever have to edit the list items in the include file and forget about the two index files forever more. ;)
Repeat for the other two subdirectories.
Possible?
Okay, I think I can muster this. I'll give it a try... https://jekyllrb.com/docs/includes/
@bloke, the first two categories are now setup. You no longer have to edit the link lists for S&C or C&P on either the homepage index(2) or the individual directory indexes. Simply update the source include files instead. https://github.com/textpattern/textpattern.github.io/tree/master/_includes
- index-lists-build.html
- index-lists-setup.html
I have not touched the Tags index yet because I don't want to step on toes, but when you look at the logic of the includes and how it defines and auto-creates the directory indexes, it's clear it should be done for consistency.
cc @philwareham