Go to main content

Textpattern CMS support forum

You are not logged in. Register | Login | Help

#11 2019-12-11 16:02:21

jakob
Admin
From: Germany
Registered: 2005-01-20
Posts: 3,854
Website

Re: User docs changes

Sorry for chiming in there so brutally. But thank you!

PS: If you’re working on files in a folder and have a good(-ish) text editor, you should be able to mass search and replace the /reference out the links. If you happen to use atom, then drop the folder on the atom app and then right-click and choose “search in folder”.


TXP Builders – finely-crafted code, design and txp

Offline

#12 2019-12-11 20:48:20

Destry
Member
From: Haut-Rhin
Registered: 2004-08-04
Posts: 4,394
Website

Re: User docs changes

jakob wrote #320471:

If you’re working on files in a folder and have a good(-ish) text editor, you should be able to mass search and replace the /reference out the links. If you happen to use atom, then drop the folder on the atom app and then right-click and choose “search in folder”.

Yeah, we should push forth with ‘Plan A’ since it’s so easy to fix those links. ;)

Truth is, it’s not about fixing links, really. In fact, as you point out, that part is kind of trivial if you use the right approach. The problem is that the /tags directory structure was not well considered in the beginning, and we were trying to improve it with includes and whatnot to help manage indexes consistently. So this was an attempt to improve the overall architecture of the docs site, not just tags alone. And fixing architecture out ranks the initial broken links, IMO, which can always be fixed with find/replace.

I think if the flat-file docs had been created as follows, where tags were logically organized by their category, which is how they are actually presented in docs anyway, nobody would be thinking twice about it now.

  • tags
    • article
      • article
      • article_custom
      • article_id
      • . . .
      • index.md
    • comment
      • comment_anchor.md
      • comment_email.md
      • . . .
      • index.md
    • . . .
    • shortcodes
    • index.md
    • tags-attributes-cross-reference.md
    • . . .

Giving URLs like:

https://docs.textpattern.com/tags/article/article_custom.md
https://docs.textpattern.com/tags/comment/comment_anchor.md

But this recent change was kind of a shortcut fix to at least get the tag pages isolated, and to use the parent /tags index as a complete directory index, as opposed to a somewhat confusing tags pages only index as it is now.

Just to explain the backstory/problem as I see it.

But we aim to please.

Offline

Board footer

Powered by FluxBB