Go to main content

Textpattern CMS support forum

You are not logged in. Register | Login | Help

#1 2008-10-03 14:11:25

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

[wiki] TextBook Extensions

Remembering that the primary use of the wiki is for developing Txp user docs (as well collaboration/administration in that direction), if you think you know a useful extension, please point it out. Doing so does not necessarily mean it will get added to the wiki, but knowing it exists is a first step. Ideal recommendations are for extensions that 1) solve an existing, recognized problem (a big factor), 2) show a strong development history, and 3) are compatible with current MW version (evaluate against the extension matrix). Be aware many extensions do the same things, so always look for the best of the breed (and holler if you think something should be swapped in the lists).

To know what extensions are already added to TextBook, see special:Version.

Since development knights are often not known for their documentation skills, we provide our own extension help docs; see in help:Contents under Extensions Management and Use.

————————————————————————————-

Candidates for Implementation

  • DiscussionThreading — Turns an article’s discussion page into a threaded forum topic. Could solve issues like being discussed in later posts here. Highlights include auto-addition of wiki user signatures, ability to add new posts or edit/reply to existing posts, track conversation…the usual board fare. (Another version called “LiquidThreads”:“LiquidThreads”:http://www.mediawiki.org/wiki/Extension:LiquidThreads)
  • EditWarning — Shows a warning message if you try and edit a page in the process of being edited by someone else.

Under Consideration

  • UserImageGallery — Sorts the main file gallery by user and returns subgallery reflecting uploads specific to a given user. (Could be a great way to track — and kill — outdated images.)
  • DocumentApproval — Provides the ability to put an article under an approval process from first drafting to final editing/validation. Could be very useful for those who can start pages but don’t have the words to finish them and want an “editor” to swing by. This could also work well in relation with the collaborative page status flags. (Note this is used on a page-by-page basis as the first author desires; it does not apply to the wiki globally.)
  • Lockdown — Could be useful to restrict admin-related content to just admins (e.g., when it’s back-end related info)
  • Calendar – There’s many calendar extensions. One could be useful if in the future the community started TextPowWow, TextMeet, or whatever (like WordCamp) and wanted an easy way to collaborate on organizing such events. (Mmmmmm TextMeet! The blue plate special.)

Last edited by Destry (2008-11-14 19:14:57)

Offline

#2 2008-10-16 11:20:29

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

Re: [wiki] TextBook Extensions

The MultiUpload extension has been implemented.

Last edited by Destry (2008-10-23 09:05:04)

Offline

#3 2008-10-23 09:08:04

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

Re: [wiki] TextBook Extensions

The DeleteBatch extension has been implemented. This is a special rights extension only.

Offline

#4 2008-11-05 22:37:13

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

Re: [wiki] TextBook Extensions

The Contribution Scores extension has been implemented. (A working alternative to the Social Rewarding extension.)

It shows the top 50 greatest contributions by user (past 7 days, past 30 days, and entire history). If the 7 and 30 day lists don’t show 50 names; it means there wasn’t 50 different users contributing in those time periods.

Because a person can make many small contributions (e.g., fix typos) and thus appear high ranked all other factors aside (as opposed to a person who may make few contributions, but completely rewrite a page for considerable improvement), the extension uses a calculation to normalize the ranking a bit across contribution quality, for what it’s worth.

Last edited by Destry (2008-11-05 22:39:26)

Offline

#5 2008-11-05 23:54:57

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

Re: [wiki] TextBook Extensions

That’s fun :)

You should include implementing extensions in the calculation ;)

Offline

#6 2008-11-06 00:07:57

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

Re: [wiki] TextBook Extensions

Anyone have experience with <HTML>DOC? It’s necessary to make the PdfBook extension work, but I’m not sure if I can install htmldoc or if it needs done by mamash at Joyent. The instructions for the PdfBook extension are a little lean on details so I don’t even know where it’s supposed to be installed at.

Els wrote:

You should include implementing extensions in the calculation ;)

:) Yeah, among other things.

Last edited by Destry (2008-11-06 00:20:38)

Offline

#7 2008-11-14 19:05:57

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

Re: [wiki] TextBook Extensions

The PdfBook extension has been implemented. (Thanks to Filip “mamash”, who had to install HTMLDOC at the Joyent end of things.)

There is no special page to this extension. It functions by adding a special parser tag where you want the PDF Book functionality to begin, which can be in any category page. Naturally, we are using this predominantly for the Tag Reference, but not exclusively.

The formatting of the PDF output is pretty darn good by default. It turns each page alphabetized under a given category into a numbered section in the PDF doc. Table of contents are generated automatically. It’s also pretty fast, at least by my DSL connection using MacPro.

Minor Annoyances:

The first page of a given book tends to be blank, for some reason, but after that it parses nicely, first the TOC, then each page section/subsections.

Also, wiki subcategories, such as the subcategories in the Tag Reference category, do not create subsections in the book, rather they are alphabetized along with the pages themselves and appear as book sections just like the tag pages do. A person could get around this by one of two ways at the moment:
  • either printing each subcategory as a separate book (a book print link has been added to each subcategory), which might be best as you then have tags in context of their various category associations, or
  • by using Adobe to remove the erroneous subcategory pages from the comprehensive Tag Reference book, which is simply a long alphabetical listing of all tags.

We’ll try and improve on it as we go along, but this should be an immensely welcome addition as it is.

Offline

#8 2008-11-14 19:58:24

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

Re: [wiki] TextBook Extensions

Wow, 170 pages! That looks really neat. I noticed it doesn’t use the screen styles (so fortunately it doesn’t matter that we still have to do some markup cleaning). As for the examples and their headings, this is a good enough motivation to keep working on them (I’ll try and do some more this weekend) ;)
Great addition Destry!

Offline

#9 2008-11-14 20:35:15

Bloke
Developer
From: Leeds, UK
Registered: 2006-01-29
Posts: 11,683
Website GitHub

Re: [wiki] TextBook Extensions

Sweet! Nice one, Destry.

Though I don’t advocate printing, when saved to the hard drive it’s a handy reference for the times when working offline.

Re: the examples and tags, I had a blitz through the other day starting with the if_ pages and working out (hence my current bloated score!) I think I caught most — if not all — of the examples and shortened the titles where appropriate, got rid of the attribute <code> tags, etc. There may be a few lurking that I missed as I didn’t have much of a system going.

I also worked on some of the admin pages, uploading more compact gfx (after instruction from Destry), tidied a few pages, corrected outdated links, etc. Still have a ways to go on all that, but it’s definitely taking shape… just in time for it to change in 4.0.7! But it’ll be a truckload easier to maintain from hereon out I think. The screen grab/crop/reshuffle/add arrow/save/upload dance was the most time-consuming part I found, so if anyone is a dab hand at Photoshop or equivalent, it’d be most appreciated to tidy the gfx to resemble this type of thing.

It’s a big job for 3 or 4 people, so anyone who has a spare half hour here and there, please feel free to grab an account, pick a topic and edit it to make sense/fix links for today’s TXP. Thanks!


The smd plugin menagerie — for when you need one more gribble of power from Textpattern. Bleeding-edge code available on GitHub.

Txp Builders – finely-crafted code, design and Txp

Offline

#10 2008-11-14 20:49:26

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

Re: [wiki] TextBook Extensions

Bloke wrote:

my current bloated score!

How am I ever going to catch up with that… chapeau!

I think I caught most — if not all — of the examples and shortened the titles where appropriate

Hurray, unexpected weekend off :) I hadn’t noticed that until now, great work! I’ll see what else I can do then.

Offline

#11 2008-11-15 23:38:42

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

Re: [wiki] TextBook Extensions

Bloke wrote:

Though I don’t advocate printing

Good point. Neither do I, at least not all at once. I’ve written up an announcement about the feature, and offered some alternative thinking in the “Keep it Green” section.

And, um…let’s take the Tag Ref talk back over here.

Last edited by Destry (2008-11-15 23:50:36)

Offline

Board footer

Powered by FluxBB