DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: jEdit external TypoScript editor (server part)

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed:2006-03-25T19:33:21
Email:neil@tasmanstudios.co.nz

EXT: jEdit external TypoScript editor (server part)

Extension Key: jeditvfs

Copyright 2005-2006, neil@tasmanstudios.co.nz, <neil@tasmanstudios.co.nz>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents

EXT: XMLRPC>jEdit VFS 1

Introduction 1

What does it do? 1

Screenshots 2

Users manual 2

Configuration 3

Known problems 3

Changelog 3

Introduction

What does it do?

This extension provides an XMLRPC interface to TYPO3's TypoScript setup and constants for editing in the excellent jEdit text editor, complete with syntax highlighting and auto-indent. By its nature, this extension could be used with any other editor that supports a virtual filesystem. If any developers would like assistance in interfacing with this extension, please contact me.

jEdit can be found at http://www.jedit.org . It is written in Java, and was originally coded by a friend of mine. It is available packaged for Linux, MacOS X and Windows, but will run on any platform that supports Java 1.4, including OS/2, VMS, Solaris, etc.

This extension was developed out of a need to manage templates across many TYPO3 installations that we administer at tasmanstudios ltd ( http://www.tasmanstudios.co.nz ), I hope you find it useful! Feedback is appreciated.

Screenshots

img-1 img-2

Users manual

There is very little to do with this extension itself. Once it's installed, it should just work.

In order to use it from within jEdit, you will need to install jEdit from http://jedit.org and then install the TypoScript plugin using jEdit's plugin manager. Please see jEdit's online help for information on installing plugins.

Configuration

While this extension is designed to not require any configuration, it does have a very small amount of statically-included typoscript that can be tuned if required. Please note that the jEdit plugin basically requires this plugin to be configured in its default state to work.

The setup included is:

jeditpage = PAGE
jeditpage.typeNum = 761
jeditpage.config {
        no_cache = 1
        pageGenScript=EXT:jeditvfs/server.php
        admPanel = 0
}

As should be evident, it creates a new typenum 761, on which it exposes an XMLRPC interface. You could change this typenum if you needed to. It is in theory possible to change the typenum used by the jEdit plugin too, but this would require rebuilding the plugin's JAR file with the new configuration.

Basically, don't change the configuration!

Known problems

Because of the way the TYPO3 backend authentication system works, performing proper secure “superchallenged” authentication between jEdit and TYPO3 is impossible. The plugin sends your admin password in the clear over HTTP. Beware when using this system to administer remote sites and consider using an encrypted VPN or an SSL webserver if you are worried about someone eavesdropping on the connection.

Authentication has only been tested using standard be_user lookup, but this extension has been designed to utilise auth services, and should therefore support other schemes such as IP-based or LDAP-based authentication where it complies with the auth services API. If you use an exotic backend authentication scheme and find your admin-level login failing, please contact me and I'll see what I can do.

Syntax highlighting doesn't work if you have a version of jEdit less than 4.3pre4 and don't have version 0.1.1 or greater of the client.

Client version 0.1.0 is not compatible with TYPO3 4.0. This extension and version 0.1.1 of the client has been tested for basic functionality against TYPO3 4.0 beta 3.

There have been reports of Umlauts not transferring properly for Windows users. I've tried to provide a remedy, but there seems to still be issues. If you have this problem (especially on a non-windows system) please email me.

Changelog

25 th mar 2006 – Updated documentation to reflect 0.1.1 being out in jEdit's repository

4 th Mar 2006 – Changed syntax highlighting note to include link to mailing list post

24 th Feb 2006 – Added the capability to access multiple templates per page and fixed some reported bugs

17 th Jan 2006 - Initial public release on TER after internal company beta.

img-3 EXT: jEdit external TypoScript editor (server part) - 3