vit$oft freeware home page

JAM2HTM konvertor

Účel programu

Utilita JAM2HTM konvertuje databázi zpráv formátu JAM (msgbáze) na HTML internetové stránky. Je určena pro operátory stanic sítě Fido, kteří současně provozují internetový/intranetový server nebo kteří chtějí využívat internetový prohlížeč ke čtení Fido konferencí.

Návod na rychlé vyzkoušení

  1. Vygenerujte defaultní šablony INDEX.HTX a SUBJECT.HTX příkazem JAM2HTM /C /G.
  2. Do aktuálního adresáře s šablonami zkopírujte některou konferenci ze své msgbáze (např. soubory GOLDED.JDT a GOLDED.JHR).
  3. Zkonvertujte konferenci příkazem JAM2HTM GOLDED Editor zpráv GoldEd . První parametr (GOLDED) je název souboru konference (bez přípony, cesta může být uvedena). Zbytek příkazového řádku je nepovinný stručný popis konference.
  4. Prohlédněte si vzniklý soubor INDEX.HTM internetovým prohlížečem a seznamte se s možnostmi prohlížení zpráv touto technikou.
  5. Pomocí HTML editoru můžete upravit šablony.HTX, pokud vám nevyhovuje defaultní design konvertovaných stránek.
  6. Pokud se rozhodnete využívat tuto utilitu pravidelně k obšťastňování návštěvníků svého WWW serveru, vytvořte dávkový soubor (jako vzor poslouží JAM2HTM.BAT) a zařiďte jeho pravidelné spouštění v noci nebo po každém převzetí nové Fido pošty.

Nároky programu

JAM2HTM je bezobslužná dosová utilita, která může být spouštěna v operačním systému DOS, OS/2 nebo Windows. Vyžaduje procesor i386 nebo lepší a nejméně 320KB konvenční paměti.

Souborové schéma

Databáze zpráv JAM je tvořena čtyřmi soubory na každou konferenci. Jen dva jsou využívány pro konverzi: Board.JHR a Board.JDT (Board je konkrétní název konference). JAM2HTM čte tyto soubory ve sdíleném režimu a nikdy je nemění.

Každá konference může obsahovat množství zpráv týkajících se rozličných témat - Subjektů. Pro každé téma, které se v konferenci vyskytne, je generována zvláštní stránka s názvem SUBJ000.HTM, SUBJ001.HTM atd.
Po konverzi celé msgbáze jsou témata abecedně seřazena a vytváří se stránka INDEX.HTM obsahující přehled témat a jejich vazby na příslušné soubory SUBJxxx.HTM.
Název vstupní msgbáze lze zadávat s plnou cestou, názvy souborů šablon jsou pevně dány a musí ležet v aktuálním adresáři. Výstupní HTM stránky se rozněž vytvářejí vždy v aktuálním adresáři. 

   JAM msgbáze               konvertor         výsledné HTML stránky
   +-----------+        +-----------------+       +-------------+
   | board.JHR |------->|                 |------>|  INDEX.HTM  |
   +-----------+        |                 |       +-------------+
   +-----------+        |                 |       +-------------+
   | board.JDT |------->|                 |------>| SUBJ001.HTM |
   +-----------+        |                 |       +-------------+
                        |JAM2HTM.COM board|       +-------------+
      šablony           |                 |------>| SUBJ002.HTM |
  +-------------+       |                 |       +-------------+
  |  INDEX.HTX  |------>|                 |       +-------------+
  +-------------+       |                 |------>| SUBJ003.HTM |
  +-------------+       |                 |       +-------------+
  | SUBJECT.HTX |------>|                 |              .
  +-------------+       +-----------------+              .

Zařazení výsledků na internet

Sami vytvořte úvodní stránku (např. FIDO.HTM) obsahující seznam zpřístupněných konferencí, jejich charakteristiky a odkazy na odpovídající indexové soubory. Pro každou konferenci vytvořte na WWW serveru adresář, zkonvertujte ji a výsledné stránky přesuňte do odpovídajícího adresáře Web serveru.
Typický adresářový strom WWW serveru může vypadat takto: 
      /HOME.HTM                             výchozí stránka
      |
      |
      +------/FIDO/
      |        |   FIDO.HTM                seznam konferencí
      |        |
      |        +---/FIDO/GOLDED/
      |        |               INDEX.HTM
      |        |               SUBJ000.HTM
      |        |               SUBJ001.HTM
      |        |               SUBJ002.HTM
      |        |
      |        +---/FIDO/NOVELL/
      |        |               INDEX.HTM
      |        |               SUBJ000.HTM
      |        |               SUBJ001.HTM

Vytváření šablon

Šablony jsou normální HTML textové soubory s několika přídavnými proměnnými prvky uzavřenými ve znacích %, např. <%SenderName%>. Tyto proměnné budou během konverze nahrazeny odpovídajícími hodnotami. Kompletní seznam proměnných prvků bude uveden níže. Výchozí šablony INDEX.HTX a SUBJECT.HTX můžete vygenerovat příkazem JAM2HTM /C /G.

Struktura šablon.HTX

Stránka typu HTX obsahuje dva speciální oddělovače: <%BeginDetail%> a <%EndDetail%>. Oddíl mezi těmito prvky budeme nazývat Detail a jeho obsah se kopíruje do výstupní stránky tolikrát, kolik je zpracovávaných položek. Oddíly Prolog a Epilog se přenášejí jen jednou. 
      Šablona.HTX                    oddíl
   +-----------------------+
   | <HTML>                |
   |  .                    |          Prolog
   |  .                    |
   | <%BeginDetail%>       |
   +-----------------------+
   |  .                    |          Detail
   |  .                    |
   +-----------------------+
   | <%EndDetail%>         |
   |  .                    |          Epilog
   |  .                    |
   | </HTML>               |
   +-----------------------+

Přehled podporovaných proměnných prvků

Název prvkuINDEXSUBJECTPříkladPopis
PrologDetailEpilogPrologDetailEpilog
<%BeginDetail%> ®  ®   Oddělovač
<%EndDetail%>   ®  ® Oddělovač
<%Today%> ®®®®®®31.12.1999 23:59Čas konverze
<%BoardName%> ®®®®®®GOLDEDNázev souboru (1.parametr)
<%BoardTitle%> ®®®®®®GoldEd message editorPopis konference (2.parametr)
<%BoardTotal%> ®®®  ®1234Celkový počet zpráv v konferenci
<%Subject%>  ® ®®®Brand New AccessSubject (téma)
<%SenderName%>     ® Pavel SrubarAutor příspěvku
<%ReceiverName%>    ® Odinn SorensenAdresát zprávy
<%DateWritten%>     ® 31.05.1998 18:20Čas vytvoření zprávy
<%MessageNr%>     ® 0001E053Identifikátor zprávy
<%Reply1st%>     ® 0000B805Identifikátor první odpovědi na tuto zprávu
<%ReplyNext%>     ® 00008A6CIdentifikátor další odpovědi
<%ReplyTo%>     ® 00000201Identifikátor předchozí zprávy
<%MessageText%>     ® Hi!Vlastní text zprávy
<%SubjectCnt%>  ®  (®)®5Počet zpráv k tomuto tématu
<%SubjectNr%>  ® ®®®000Číslo tématu (xxx v názvu souboru SUBJxxx.HTM)
<%SubjectNext%>  ®   ®015Číslo následujícího tématu
<%SubjectPrev%>  ®   ®099Číslo předchozího tématu

Proměnné prvky se mohou vyskytnout v kterékoliv části šablony, avšak jejich hodnoty mají smysl jen v oddílech označených symbolem  ®. Velikost písmen v názvu proměnné se nerozlišuje.

Zpracování textu zprávy

Proměnná <%MessageText%> by se měla uvádět jen v oddílu Detail šablony SUBJECT.HTX. Bude nahrazena textem právě zpracovávaného příspěvku. Některé řádky v textu zprávy sítě Fido mají speciální význam: K odlišení těchto služebních řádků je výhodné použít CSS styly v oddílu Prolog šablony SUBJECT.HTX.
Znaky Carriage return v textu zprávy jsou nahrazeny prvkem <BR>, ostatní řídicí znaky se vypouštějí.
Úvodní mezery na začátku řádku jsou nahrazeny pevnými mezerami.

Ze stylu Fido zpráv je dále použito několik primitivních formátovacích konvencí. Slova obklopená formátovacími značkami * / _ # se zobrazují zvýrazněným způsobem:

Řízení velikosti výsledných WWW stránek

JAM2HTM konvertuje všechny příspěvky obsažené v msgbázi, které nemají nastaven žádný z příznaků DELETED PRIVATE COMPRESS ENCRYPT NODISP.
Jediným omezením je tedy velikost disku. Počet témat (subjektů) je ale omezen na 999, případné další se ignorují.
Chcete-li snížit objem výsledných stránek, použijte prosím před konverzí některou utilitu pro údržbu JAM msgbáze. Toto je důležité i pro aktualizaci vazeb mezi zprávami (reply-links), aby bylo možné využívat hypertextové navigace internetového prohlížeče k procházení zpráv v navazujícím pořadí.

Kódování češtiny

JAM2HTM neprovádí žádnou změnu kódování. Vzhledem k tomu, že ve Fido síti se používá kód Kamenických, měla by být také diakritika v šablonách kódována tímto způsobem. Až výsledné HTM soubory je vhodné převést do kódu používaného na vašich WWW stránkách, například pomocí utility OKKONV.COM jako v následujícím příkladu.

Automatizování konverze

Následuje vzor dávkového souboru JAM2HTM.BAT pro bezobslužnou konverzi tří konferencí z JAM msgbáze umístěné na počítači FidoServer do WWW stránek umístěných na počítači WebServer: 
 @ECHO OFF
 CD /d  C:\JAM2HTM
 REM SUBJECT.HTX, INDEX.HTX, JAM2HTM.COM, JAM2HTM.BAT umístěte sem
 IF NOT "%1"=="" GOTO :OneBoard
:AllBoards
 REM  Při spuštění dávky JAM2HTM.BAT bez parametru tato rekurzivně
 REM    volá sama sebe pro každou konferenci zvlášť.
 CALL JAM2HTM.BAT GOLDED Gold Editor International
 CALL JAM2HTM.BAT NOVELL Novell Netware World Wide Echo
 CALL JAM2HTM.BAT HUDBA  Diskuse o hudbě a její tvorbě
 GOTO :End
:OneBoard      Parametry:  %1=BoardName   %2=Board title
 DEL *.HTM
 COPY \\FidoServer\FIDO\MSGBASE\%1.JHR
 COPY \\FidoServer\FIDO\MSGBASE\%1.JDT
 JAM2HTM.COM %1 %2 %3 %4 %5 %6 %7 %8 %9
 DEL %1.JHR
 DEL %1.JDT
 IF NOT EXIST \\WebServer\WWW\FIDO\%1\INDEX.HTM  MD \\WebServer\WWW\FIDO\%1
 DEL \\WebServer\WWW\FIDO\%1\*.HTM
 OKKONV *.HTM /Kamenických  \\WebServer\WWW\FIDO\%1\*.HTM /ISO~8859~2
 DEL *.HTM
:End

Registrace

Konvertor JAM2HTM je volně šířitelný freeware a nevyžaduje registraci. Nicméně vítám připomínky, hlášení závad a URL adresy Web serverů, na kterých bude tato technika využívána, a to nejlépe Fido netmailem na adresu Pavel Šrubař 2:421/71, případně Pavel.Srubar@post.cz.

Historie

vit$oft freeware home page