Go to main content

Textpattern CMS support forum

You are not logged in. Register | Login | Help

#11 2004-12-14 16:54:30

zmeigorin
New Member
From: Moscow
Registered: 2004-11-12
Posts: 6

Re: [wiki] User Manual

Destry, I think Remillard means a test install, to show it in action.

Offline

#12 2004-12-14 17:01:27

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

Re: [wiki] User Manual

Ah, I see. Well then, carry on.

Offline

#13 2004-12-14 18:12:21

Remillard
Plugin Author
From: Lenexa, KS
Registered: 2004-05-16
Posts: 169

Re: [wiki] User Manual

Well, no, I actually meant to actually host it :).

Instiki has some nice features though that protect against this sort of thing (or at least mitigate the damage).

  • It does daily backups of the changelog.
  • It is possible to zip up the entire wiki and move it with little effort.

So, if I got it working and something didn’t work out (e.g. the bandwidth suck is greater than I expected for a home account, etc), we can work something out and I can send the wiki to its next home with no loss.

I’m also looking to moving my site to Textdrive, so that would sort of solve everything.

… I guess I’ll carry on then … ;-) if nothing else, it’s an interesting experiment to get it working.

EDIT: And, according to Instiki’s web site, it’s having trouble with some sort of rollback bug (due to something or the other.) That would be very bad for a site that’s entire purpose is to track revision changes. So, I’ll investigate alternatives.

Last edited by Remillard (2004-12-14 18:26:33)

Offline

#14 2004-12-14 19:07:48

Damelon
Member
From: Lyon, France
Registered: 2004-05-11
Posts: 47
Website

Re: [wiki] User Manual

> Destry wrote:
> My French is still quite rudimentary (to say the least). Though I might be able to coerce
> my beautiful better half into lending me a hand, but no promises.

Yes, I love France too.

Offline

#15 2004-12-14 19:08:12

Remillard
Plugin Author
From: Lenexa, KS
Registered: 2004-05-16
Posts: 169

Re: [wiki] User Manual

Alright. I did some poking around, and honestly MediaWiki does seem to be the best setup for this sort of thing. I rather like all the sub-page discussion so that regions can be discussed.

At the moment, I don’t have images permitted, but if it becomes necessary (illustrations) then I can add that.

Additionally, this is NOT on my home machine. This is on my regular site and there are regular backups and all of that good stuff.

So, without further ado, Textpattern Manual Project

I think Destry’s outline is a good place to start. I haven’t really had a chance to do much but install and do some basic security things (like the login to edit thing). Later this afternoon I’ll try to whack in the outline so there are sections to manage.

Have fun.

Last edited by Remillard (2004-12-14 21:06:41)

Offline

#16 2004-12-14 19:39:43

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

Re: [wiki] User Manual

<em>Remillard wrote:
<blockquote>Well, no, I actually meant to actually host it :).</blockquote></em>

Ah, that’s what I thought. You seemed clear enough.

<em><blockquote>“So, without further ado, Textpattern Documentation Project.”</em></blockquote>

ROCK-ON, Remillard!

(p.s., any chance of changing that link to read “Textpattern Manual Project” (?) I think it’s important to get the distinction down early so there’s no confusion. I’m mean documentation could be code documentation, Textpattern Resources documentation, etc. Circulating a clear focus on “manual” will be very helpful in dialogue.) – If we can get a true label hammered-down, we’ll be even better off. So vote people!

<em>Damelon wrote:
<blockquote>“Yes, I love France too.”</blockquote></em>

<em>Aint</em> it true.

Offline

#17 2004-12-14 20:03:39

zmeigorin
New Member
From: Moscow
Registered: 2004-11-12
Posts: 6

Re: [wiki] User Manual

And, Maybe a kind of Appendix C: Extending Textpattern? Describing plugins, maybe basic code layout and architecture, etc.

Offline

#18 2004-12-14 20:42:09

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

Re: [wiki] User Manual

<em>zmeigorin wrote:
<blockquote>“And, Maybe a kind of Appendix C: Extending Textpattern? Describing plugins, maybe basic code layout and architecture, etc.”</blockquote></em>

Hmmm…I knew this was going to come up sooner or later, and it’s good that it’s sooner. Personally, I don’t think this is such a good idea, for the very simple reason that it’s out of scope with what is trying to be achieved here.

I would redirect your attention back to the project outline at the head of this thread, and see #3 under the <strong><em>Basic Notions for a Textpattern User Manual</em></strong>. The idea here, as I see it, is a manual that you would get if you bought TxP and it came on a CD. The manual is only going to be addressing what is native to the current release, and it’s going to be talking to <strong>general users</strong>.

What you’re talking about is specialized information for the developer/programmer crowd, and that’s not the target audience for this manual. It might be the subject for another manual somewhere down the line (a developers manual for instance), but again, it’s out of scope here.

Now you did mention “basic layout and architecture.” That idea is already expressed in Chapter 5 of the structure, and it seems perfectly legite that this would be there, but only very basic info. No designer stuff, no CSS how tos, or whatever. All that is out of scope. Just the bare bones skeleton is all were talking about here, to get the new user on the right track.

Make use of the Textpattern Resources site for developer issues.

My two cents.

Offline

#19 2004-12-14 21:16:09

hakjoon
Moderator
From: Arlington, VA
Registered: 2004-07-29
Posts: 1,634
Website

Re: [wiki] User Manual

I think an extending TXP section as an Appendix, that could give some basic info and maybe point to a Developer’s resource is not a bad idea. After all if this does become a main doc people will come here looking for that info so it should at least point readers in the right direction. The extensibility of a system is also a selling point so it should at least be highlighted.

I can’t believe how much you guys did since I logged off yesterday.


Shoving is the answer – pusher robot

Offline

#20 2004-12-14 21:16:43

Remillard
Plugin Author
From: Lenexa, KS
Registered: 2004-05-16
Posts: 169

Re: [wiki] User Manual

Well I appreciate the rock’ing and the on’ing, however frankly this is the easiest part. Without folks jumping in and actually doing some of the typing and thinking, it’s not going anywhere. It’s also not like this hasn’t been tried before. The Trac docs had few if any contributors, and there’ve been a few other attempts here and there.

I changed the link text. No problem there. i don’t mind trying to make this a little more formalized, but if you mention a 6-sigma process I’m going to scream and spontaneously combust ;-). I will only groan and kill the lights with a migraine if you mention ISO9000.

As far as having some sort of help documentation on plugins and hacks, I think it’s a good idea. I don’t care if it’s an appendix or a different “book”. However, I’m not sure TXP.org is the best place to collaborate on it. The TXP Resources is sort of a repository of things/news/etc. While it could house a manual, trust me, doing something even close to a manual in the little edit window is … daunting (and I should know after TXP-121-1.) The wiki allows a breakdown much like Linux HOWTO docs with a proper TOC and so on and so forth.

So, let’s see some folks get to typing. ;-)

Offline

Board footer

Powered by FluxBB