src2html Anleitung

Einleitung

Vorhandene Funktionen

• Alle Funktions- und Prozeduraufrufe werden zu Hyperlinks die zur jeweiligen Definition führen. Dabei wird die Sprache Chill, und C (incl. C++ Kommentaren) unterstützt.
• Automatische Erkennung der verwendeten Programmiersprache
• Der Code wird farbig markiert, wobei zwischen
  • Strings
  • Digits
  • Schlüsselwörter der Sprache (erweiterbar)
  • Kommentar
  • Frei definierbare Schlüsselwörter
  unterschieden wird.
• Der einzusetzende HTML-Code kann vorgegeben werden
• Eigene Javascript Funktionen können eingebunden werden
• Alle Funktions- und Prozedurnamen werden in einem eigenen Frame angezeigt
• Auch Browser die keine Frames unterstützen werden unterstützt

Einschränkungen

• Der Source-Code muss fehlerfrei durch einen Compiler laufen
• Gleichnamige Funktionen mit verschiedenen Parametertypen werden nicht unterschieden
• Unter DOS darf, wegen der 8.3 Einschränkung, der Name des Sources max. 5 Zeichen haben, z.B. "ABCDE.C" ist ok. Die *.htm Datei kann jedoch nachträglich umbenannt werden.
• Unter Linux/Unix werden keine versteckten Dateien (.xxx.c) oder Verzeichnisse in den Parametern beim Aufruf unterstützt
• Include files werden nicht automatisch nachgeladen, können aber vor der Konvertierung in die Source-Datei kopiert werden.
• Die INI-Files müssen in dem Verzeichnis sein, von dem src2html aufgerufen wird.

Mitgelieferte Dateien

• src2html.ini
• langkeywords.ini
• otherkeywords.ini

• src2html.js

• src2html.ini
• langkeywords.ini

Starten von src2html

Farben anpassen

 4, 5, 6 Definition einer Prozedur/Funktion
;   <font color=purple><a name="targetdef">define target</a></font>
;   ----------------------------         --             -----------
;   4. (zs_html_proc_def_a)
4.<font color=purple><a name="
;   5. (zs_html_proc_def_b)
5.">
;   6. (zs_html_proc_def_c)
6.</a></font>

7, 8, 9 Hyperlink zu einer Prozedur/Funktion
;   <a href="#targetdef">link to target</a>
;   ---------          --              ----
;   7. (zs_html_proc_use_a)
7.<a href="
;   8. (zs_html_proc_use_b)
8.">
;   9. (zs_html_proc_use_c)
9.</a>

10, 11, 12 Hyperlink zu einer auskommentierten Prozedur/Funktion

;   <a href="#targetdef"><font color=forestgreen>link to target</font></a>
;   ---------           -------------------------              -----------
;   10. (zs_html_cproc_use_a)
10.<a href="
;   11. (zs_html_cproc_use_b)
11."><font color=forestgreen>
;   12. (zs_html_cproc_use_c)
12.</font></a>

13, 14, 28 Schlüsselwörter die in langkeywords.ini definiert sind

Beispiel ohne 28.:

;   <font color=blue>blue text</font>
;   -----------------         -------
;   13. (zs_html_keyword_def_a)
13.<font color=blue>
;   14. (zs_html_keyword_def_b)
14.</font>
  
Beispiel mit 28.:
; if you define 28, the keyword is printed twice!
; so 13 and 14 are used in another way  
; example:
;   <a href="javascript:q_help('keyword')" style="text-decoration: none;color:blue;">keyword</a>
;   ----------------------------       ----------------------------------------------       ----
;   13. (zs_html_other_keyword_def_a)
13.<a href="javascript:q_help('
;   14. (zs_html_keyword_def_b)
14.')" style="text-decoration: none;color:blue;">
;   28. (zs_html_keyword_def_c)
28.</a>

15, 16 Auskommentierte Schlüsselwörter die in langkeywords.ini definiert sind
;   15, 16 color of comments
;   <font color=forestgreen>forestgreen text</font>
;   ------------------------                -------
;   15. (zs_html_comment_def_a)
15.<font color=forestgreen>
;   16. (zs_html_comment_def_b)
16.</font>

17, 18 Zahlen
;   17, 18 color of digits (e.g. 123 )
;   <font color=red>red text</font>
;   ----------------        -------
;   17 (zs_digitStart)
17.<font color=red>
;   18 (zs_digitEnd)
18.</font>

19, 20 Zeichenketten "ABC"
;   19, 20 color of strings (e.g. "ABC" )
;   <font color=dimgray>dimgray text</font>
;   --------------------            -------
;   19 (zs_StringStart)
19.<font color=dimgray>
;   20 (zs_StringEnd)
20.</font>

21, 22 Character 'A'
;   21, 22 color of char (e.g. 'A' )
;   <font color=dimgray>dimgray text</font>
;   --------------------            -------
;   21 (zs_CharStart)

21.<font color=dimgray>
;   22 (zs_CharEnd)
22.</font>

23, 24 Chill Binär- und Hexziffern H'FF 
;   23, 24 color of binary or hex digits in chill (e.g. H'FFFF)
;   <font color=red>red text</font>
;   ----------------        -------
;   23 (zs_ChillCharStart)
23.<font color=red>
;   24 (zs_ChillCharEnd)
24.</font>

25, 26, 27 Schlüsselwörter die in otherkeywords.ini definiert sind

Beispiel ohne 27.:

;   25, 26 color of other keywords  (27 not defined)
;   declared in otherkeywords.ini
;   <font color=red>keyword</font>
;   ----------------       -------
;   25. (zs_html_other_keyword_def_a)
25.<font color=red>
;   26. (zs_html_other_keyword_def_b)
26.</font>

Beispiel mit 27.:
; if you define 27, the keyword is printed twice!
; so 25 and 26 are used in another way  
; example:
;   <a href="javascript:q_help('keyword')" style="text-decoration: none;color:blue;">keyword</a>
;   ----------------------------       ----------------------------------------------       ----
;   25. (zs_html_other_keyword_def_a)
25.<a href="javascript:q_help('
;   26. (zs_html_other_keyword_def_b)
26.')" style="text-decoration: none;color:blue;">
;   27. (zs_html_other_keyword_def_c)
27.</a>

Farben der Frames
Die Farben und Größen lassen sich vorgeben, der Titel ist jedoch immer der Name der Source-Datei.

Source Frame
;   1. Headerline of Source frame  (zs_first_line_a2)
1.</title></head><body bgcolor=#ffffff text=black link=purple vlink=purple alink=silver><font color=black><pre>

Linker Frame mit der Liste der Prozeduren/Funktionen
;   2. Headerline of left frame (zs_first_line_a2pl)
2.</title></head><body bgcolor=#ffffff text=black link=purple vlink=purple alink=silver><font color=black><pre>

Größe der Frames
 
;   3. Frame definition (zs_FrameDef_a1)
3."</title></head><frameset cols="20%,*" border=1 frameborder=1 framespacing=1><frame src="

Beispiel mit Javascript

Definition der Keywords

Deklaration der Javascript Funktion

  1.</title><script language="JavaScript" src="src2html.js" type="text/javascript"></script></head><body bgcolor=#ffffff text=black link=purple vlink=purple alink=silver><font color=black><pre> 
:
.
  25.<a href="javascript:q_help('
  ;   otherkeyword
  26.')" style="text-decoration: none;color:blue;">
  ;   other_keyword
  27.</a>             

Definition der Javascript Funktion

function q_help( zp_anchor)
 {    
   MeinFenster = window.open("info.html", "helpfile");
   MeinFenster.focus();
   MeinFenster.location.href = "info.html#"+zp_anchor;
 }

Editorial