XetorjEditin lyhyt käyttöohje

• Asennus
• Jeditin ominaisuudet
• Rakennenäkymä (engl. structure browser)
• Koodinäkymä
• Virhelista
• XML Insert
• Ulkoasun muokkaus

jEdit on Java-pohjainen tekstieditori, johon Xetor-sovellusprojektissa on kehitetty XML-editointiin tarkoitettuja lisätyökaluja. Projektia on jatkokehittänyt Jussi Räisänen. Xetorin uusimman version saat (Windows-käyttöjärjestelmille) osoitteesta:

http://appro.mit.jyu.fi/tools/xetor/XetorInstall.exe

Asennusohjelma ei luultavasti toimi Windows 98:lla.

Tarvitset myös Javasta uudehkon version (>=1.3) osoitteesta:

http://java.com/en/download/manual.jsp

Asennus

Lyhyet ohjeet ohjelman käyttöönottoon:

1. Asenna Java ellei sitä ole jo koneellasi.
2. Lataa asennuspaketti ja valitse lopuksi Open (IE) tai Launch file (Mozilla).
3. Hyväksy lisenssi (GPL), valitse asennushakemisto ja paina Next:iä.
4. Valitse lopuksi valinta Run XetorjEdit ja paina Finish.
5. Kokeile toimintaa kopioimalla XHTML Simple -dokumenttityypin mukainen pohjakoodi leikepöydän kautta koodi-ikkunaan. Tallenna dokumentti .html-päätteellä.
6. Vastaa myöntävästi dokumenttityyppimäärityksen (dtd) hakuun internetistä. Toimiakseen oikein Xetor tarvitsee aina DTD-muotoisen dokumenttityypin määrityksen. Jos erehtyy kieltämään Xetorilta DTD:n tai sen osien hakemisen niin dokumentin validointi ei toimi. Xetorin saa määrättyä hakemaan DTD:n uudelleen valinnalla Plugins|XML|Clear Resource Cache ja Plugins|XML|Reload Catalogs ja tallentamalla dokumentin tai sulkemalla dokumentin ja avaamalla sen uudelleen.
7. Nyt Xetor-työkalujen pitäisi olla toiminnassa.

Jeditin ominaisuudet

Xetorin pohjana toimiva JEdit-editori toimii kuten mitkä tahansa tekstieditorit. Poikkeavuuksia tavanomaisiin windows-ohjelmiin kuitenkin löytyy jo senkin takia, että ohjelma on kokonaan toteutettu Javalla.

• Tiedostoja avattaessa tai tallennettaessa käytetty dialogi on normaalista poikkeava. Kaikki levyasemat saa näkyviin Roots:-valinnalla.
• JEditissä voi olla auki useita dokumentteja samaan aikaan. Normaalista poiketen niitä voidaan selailla View-valikon kautta tai koodi-ikkunan yläpuolella olevasta alasvetovalikosta.

Rakennenäkymä (engl. structure browser)

Sovelluksen vasemmassa laidassa olevasta ikkunasta näet dokumentin rakenteen puumuodossa.

• Napauta elementtien edessä olevia vipuja, niin näet mitä elementtejä elementin sisällä on.
• Elementin lisääminen
  • Valitse hiiren vasemmalla painikkeella elementti, jonka läheisyyteen haluat uuden elementin.
  • Elementin läheisyyteen pitäisi tulla valinnat Before..., After... ja Inside...
  • Napauta jotain näistä oikealla ja valitse lisättävä elementti. Elementtivalikoima riippuu paikasta mihin olet lisäämässä uutta elementtiä.
• Elementin ominaisuudet
  • Valitse elementti oikealla hiiren napilla ja valitse ponnahdusvalikosta kohta Edit.
  • Saat esiin kuvan mukaisen ikkunan jossa voit muuttaa elementin ominaisuuksia.
  • Jos haluat asettaa ominaisuuden niin ruksita Set-sarakkeesta kyseinen attribuutti ja kirjoita ominaisuuden arvo Value-kenttään. Älä paina enteriä mikäli haluat asettaa useampia ominaisuuksia. Mikäli ominaisuudella on vain muutama mahdollinen arvo niin voit tehdä Value-kentän valinnan alasvetovalikosta.
• Elementin siirtäminen
  • Valitse hiiren oikealla painikkeella elementti, jonka haluat siirtää. Valitse Cut. Valituksi tulevat myös kaikki elementin sisällä olevat elementit.
  • Valitse oikealla napilla rakennenäkymästä elementti, jonka lähelle haluat elementin siirrettävän.
  • Valitse Paste ja alavalikosta kohta Paste Before, Paste After tai Paste Inside. Valinnasta riippuu tuleeko elementti ennen, jälkeen valitun elementin vai sen sisälle.

Koodinäkymä

Koodinäkymässä voit itse kirjoittaa elementtejä ja tekstiä. Tässä muutamia hyödyllisiä ominaisuuksia mitkä voivat helpottaa kirjoittamista:

• Kun aloitat elementin <-merkillä, niin sovellus ehdottaa automaattisesti sinulle elementit mitä voit lisätä kyseiseen kohtaan. Painamalla enteriä saa lisättyä halutun elementin alkuosan. Attribuutti-ikkunasta pääsee pois painamalla toisen kerran enteriä.
• Kirjoittamalla haluttuun paikkaan </ sovellus täydentää lisätyn elementin loppuosan.
• Vasemmassa reunassa olevista kolmiosta voi sulkea lohkoja pois näkyvistä. Kuvassa on suljettu muutaman rivin pituinen lista.
• Vasemmasta laidasta näet myös minkä alueen elementti koodista kattaa. Reunassa oleva viiva yhdistää elementin alkuosan ja loppuosan.
• Valitsemalla elementin rakennenäkymästä SHIFT-näppäin pohjassa saat valittua koodinäkymästä kaikki lohkoon kuuluvat koodit.
• Valitsemalla elementin rakennenäkymästä CTRL-näppäin pohjassa saat koodinäkymään näkyville ainoastaan lohkoon kuuluvat koodit.
• Jos haluat sisentää koodin kerralla niin valitse Plugins | XML Indenter | Indent XML.
• XML-dokumenttia voi katsella selaimessa valitsemalla Plugins | Infoviewer | Open current buffer with browser. Sisäinen Infoviewer-selain ei tue XML:ää, joten selain kannattaa vaihtaa esimerkiksi Mozilla Firefoxiin valinnalla Plugins | Plugin Options | Infoviewer | Choose Browser | External Browser. Jos selaimesi on asennettu muualle kuin oletushakemistoon niin kirjoita kohtaan External Browser Command komentopolku, jolla selain käynnistyy.

Virhelista

Jos jossain välissä (erityisesti koodi-ikkunasta) editoidessa dokumenttiin tulee epävalidiksi niin ohjelma valittaa alareunassa olevassa ikkunassa virheestä. Mikäli dokumentti ei ole jossain välissä hyvin muodostettu niin ohjelma valittaa alareunassa virheestä ja lukitsee rakennenäkymän.

• Virheen summittaisen paikan saa selville tuplanapauttamalla virhetekstiä.
• Virheen paikka näkyy myös koodi-ikkunassa alaviivatusta tekstistä. Viemällä hiiren alleviivatun tekstin päälle saa esiin virhetekstin.
• Virheilmoituksen tullessa alalaitaan kannattaa heti perua edellinen toiminto valinnalla Edit | Undo (tai näppäinyhdistelmällä CTRL + Z). Huomaa, että joskus elementin lisäämisen jälkeen on valittava kaksi kertaa Undo elementin molempien osien poistamiseksi.

XML Insert

Oikeassa reunassa näet elementtivalikoiman, joita voit lisätä siihen kohtaan mikä on tällä hetkellä valittuna.

• Napauta oikeasta reunasta elementtiä niin se lisätään valitsemaasi kohtaan.
• Voit lisätä koodinäkymään nopeasti myös "olioita" ja "erikoismerkkejä" (engl. entities) ja tunnisteviitteiden (engl. id) arvoja.

Ulkoasun muokkaus

Kun dokumentissasi on viite paikallisella koneella olevaan CSS-tiedostoon niin Xetorin avulla voit muokata suoraan ulkoasun määrityksiä:

• Valitse Plugins | XML | Show CSS Dialog.
• Jos listassa ei ole vielä tietylle elementille selektoria luotuna niin sen voi lisätä vasemmassa alareunassa kirjoittamalla selektorin nimen ja painamalla Add-painiketta.
• Valitse muokattava elementti vasemmasta laidasta. Nyt näet ominaisuudet (Property) taulukossa ja niiden arvot (Value).
• Voit lisätä uuden ominaisuuden menemällä tyhjään soluun Property-sarakkeella ja valitsemalla alasvetovalikosta ominaisuuden nimen. Voit myös kirjoittaa itse ominaisuuden nimen jos tiedät sen.
• Kirjoita ominaisuuden arvo Value-sarakkeen soluun. Jos ominaisuudella on valmiita vaihtoehtoja, niin voit valita ne alasvetovalikosta.
• Paina lopuksi Update file-painiketta jolloin muutokset päivittyvät CSS-tiedostoon.