Go to main content

Textpattern CMS support forum

You are not logged in. Register | Login | Help

#1 2007-12-14 04:26:37

robin746
Member
From: Ireland
Registered: 2007-09-22
Posts: 113
Website

how to provide custom admin doc pages

I would like to provide admin-side docs for my users. I need several pages, with links between them. Is there a good way to do this? It would be a bonus if I could serve specific pages to specific user types.

I have also posted a question on the other way of doing this.


robin

Offline

#2 2007-12-14 09:02:26

FireFusion
Member
Registered: 2005-05-10
Posts: 698

Re: how to provide custom admin doc pages

http://forum.textpattern.com/viewtopic.php?pid=84885#p84885

Offline

#3 2007-12-14 18:18:01

robin746
Member
From: Ireland
Registered: 2007-09-22
Posts: 113
Website

Re: how to provide custom admin doc pages

I have followed that thread on the dashboard plugin, which would allow linking to web pages, for example custom How-To files. But where to put them on the server or how to create them through the textpattern interface is still an issue.


robin

Offline

#4 2007-12-14 19:20:41

els
Moderator
From: The Netherlands
Registered: 2004-06-06
Posts: 7,458

Re: how to provide custom admin doc pages

You could create a ‘help’ section, using it’s own page template, and password protect that with txp:password_protect.

Offline

#5 2007-12-15 09:16:57

jakob
Admin
From: Germany
Registered: 2005-01-20
Posts: 4,726
Website

Re: how to provide custom admin doc pages

I do the same as Els and leave that section out of the menu for the rest of the site and exclude it from sitemap etc. and use robots.txt to stop it being found by search machines. You can add a help link to the backend, for instance via asy_dashboard. I don’t even bother with password protection then as that’s one thing for the users to remember.


TXP Builders – finely-crafted code, design and txp

Online

#6 2007-12-15 09:24:22

jstubbs
Member
From: Hong Kong
Registered: 2004-12-13
Posts: 2,395
Website

Re: how to provide custom admin doc pages

What do you put in robots.txt jakob? It could also be done by using a page template with a meta tag of “nofollow” too, I believe.

Offline

#7 2007-12-15 16:34:07

jakob
Admin
From: Germany
Registered: 2005-01-20
Posts: 4,726
Website

Re: how to provide custom admin doc pages

I don’t link the /help section from the front-end and use disallow in the robots file to disallow access for the robots: further infos here


TXP Builders – finely-crafted code, design and txp

Online

#8 2007-12-15 19:02:27

robin746
Member
From: Ireland
Registered: 2007-09-22
Posts: 113
Website

Re: how to provide custom admin doc pages

A shame there’s no way to add pages to the back-end. Since I do not want users to have to remember yet another password I will use the “security by obscurity” option. Thanks for the suggestions.


robin

Offline

#9 2007-12-15 20:19:09

Gocom
Developer Emeritus
From: Helsinki, Finland
Registered: 2006-07-14
Posts: 4,533
Website

Re: how to provide custom admin doc pages

A shame there’s no way to add pages to the back-end. Since I do not want users to have to remember yet another password I will use the “security by obscurity” option. Thanks for the suggestions.

Huh? Another password ain’t required, as you could use txp:password_protect or some plugin that will log in automatically if you’re logged in to the backend. And is that “hidden section” way so hard? Not it isn’t. And with custom plugin you could create new tab to backend and store the help-files inside it. That’s how I do it – create plugin that just stores help docs and other only-for-admins-staff.

Cheers!

Offline

#10 2007-12-16 14:27:44

robin746
Member
From: Ireland
Registered: 2007-09-22
Posts: 113
Website

Re: how to provide custom admin doc pages

Gocom wrote:


Huh? Another password ain’t required, as you could use txp:password_protect or some plugin that will log in automatically if you’re logged in to the backend.

The docs for txp:password_protect explicitly says you include a login and password, so I do not understand how one “ain’t required”. And I do not want to hard-code anything like this in my templates; that is just bad practice.

Furthermore the docs say “Note: It is not adequate to protect a single section.” But that seems to be exactly what is being recommended. Any explanation for these two contradictions?


And with custom plugin you could create new tab to backend and store the help-files inside it. That’s how I do it – create plugin that just stores help docs and other only-for-admins-staff.

It would be helpful to know what plugin. This is not exactly clear. I wish stale plugins and those not supported could be dropped from the online docs, or at least put in an archive section.


robin

Offline

#11 2007-12-16 14:58:12

robin746
Member
From: Ireland
Registered: 2007-09-22
Posts: 113
Website

Re: how to provide custom admin doc pages

After further investigation I’m thinking ign_password_protect will help.


robin

Offline

#12 2007-12-16 14:58:49

Gocom
Developer Emeritus
From: Helsinki, Finland
Registered: 2006-07-14
Posts: 4,533
Website

Re: how to provide custom admin doc pages

It would be helpful to know what plugin. This is not exactly clear. I wish stale plugins and those not supported could be dropped from the online docs, or at least put in an archive section.

As I said, custom plugin. Plugin that only includes something similiar to this:

if(@txpinterface == 'admin') {
	add_privs('help','1,2');
	register_tab('extensions', 'help', "Help documentary");
	register_callback('help', 'rah_help');
	global $rah_help;
}

function rah_help($event, $step){
	echo 'Your documentary here';
}

Cheers!

Last edited by Gocom (2007-12-16 14:59:32)

Offline

Board footer

Powered by FluxBB