OpenEuphoria

2. Re: Indexing Euphoria HTML Documentation for context sensitive help

• Posted by mattlewis (admin) Jan 18, 2012
• 2190 views

In its offline format, the documentation contains a javascript based search function. Take a look at the file, js/search.js. Most of this file is an index of the documentation. Right up near the top, you'll see something like:

var base=''; 
var index={ 
"allsorts.ex":[["allsorts","_369_allsortsex","Bundled Demos"]], 
"Disclaimer:":[["e2c","_645_disclaimer","Euphoria To C Translator"]], 
"declare an enumerated value":[["syntax","_274_declareanenumeratedvalue","Formal Syntax"]], 
"EXT_SIZE":[["std_filesys","_1501_ext_size","File System"]], 
"has_match":[["std_regex","_3297_has_match","Regular Expressions"]], 
"In-lining of Routine Calls":[["perform","_738_inliningofroutinecalls","Performance Tips"]], 
"Lock Type Constants":[["std_eds","_4137_locktypeconstants","Euphoria Database (EDS)"]], 
"NOTEMPTY":[["std_regex","_3189_notempty","Regular Expressions"]], 
"On / Off options":[["lang_toplevel","_182_onoffoptions","Special Top-Level Statements"]], 
"PAGE_READ_WRITE":[["std_memconst","_5905_page_read_write","Memory Constants"]], 
"PARENT":[["std_pipeio","_1895_parent","Pipe Input/Output"]], 
"regex":[["std_regex","_3251_regex","Regular Expressions"]], 
"sanity":[["sanity","_456_sanity","Bundled Demos"]], 
"Socket Type Constants":[["std_socket","_4913_sockettypeconstants","Core Sockets"]], 
"sound":[["std_win32_sounds","_6636_sound","Windows Sound"]], 

"sound":[["std_win32_sounds","_6636_sound","Windows Sound"]] 
 
becomes: 
 
std_win32_sounds.html#_6636_sound 

Hmm....it might make sense for us to generate this as a euphoria include file that would do it for you. I'm sure we could come up with a more sophisticated search than we have in the javascript function, too.

Matt

4. Re: Indexing Euphoria HTML Documentation for context sensitive help

• Posted by jimcbrown (admin) Jan 19, 2012
• 2160 views

I was there, in 2008. I was impressed that you managed to come up with a working system from nothing in a day or two.

I don't recall anyone laughing. I do recall leaving my computer for 5 minutes (I had to pee!) and then coming back and seeing you had asked and then decided to delete everything while I was gone.

There are technical difficulties with using IRC bots exclusively for that functionality (such as the difficulties of putting a web page on the web to search or allowing others to do off-line searches), which leaves the door open for other approaches to spring up and co-exist side-by-side.

6. Re: Indexing Euphoria HTML Documentation for context sensitive help

• Posted by useless_ Jan 20, 2012
• 2071 views

Thanks. I used hackserv by bjackson, which used code by jconsuegra and gharris, and DCuny's win32lib v0.42, all glued to the backside of mirc to be the irc presence. I wish i could remember who helped with the php code later.

I had a system for Tiggr to respond to publicly available webpages via any browser. You contact the site with your search criteria, the site used php to contact Tiggr at my home, and she'd generate a reply and wrap it in html back to the php on the server, and the php on the commercially hosted site forwarded this to you transparently. This solves some major problems with irc when dealing with a lot of data, data needing formatting, or with pictures. Like asking her what an AT32UC3L064 is.

People complained bitterly about having the http link to the answer when the question was asked on irc. And they wouldn't ask Tiggr thru a browser interface as simple as a Google box in a browser window. No matter how much code i wrote, or data i made available, it was never acceptable. In the late 1990's, Tiggr even recieved and sent email, no one ever used it.

Good luck. I am truely wondering how you'll ever satisfy more than just yourself with this.

useless
Forked into: Search and Nostalgia

8. Re: Indexing Euphoria HTML Documentation for context sensitive help

• Posted by K_D_R Nov 07, 2012
• 1754 views

k = db_find_key(search_word)                                                                        
if k > 0 then                                                                                       
      index = db_record_data(k)                                                                       
      section = index[1]                                                                              
      index = index[2]                                                                                
      system_exec(BROWSER & "file:///home/kenneth/euphoria.4.0.3/docs/html/" & section               
& ".html#_" & index & "_" & search_word, 0)   
end if 

Well, I spent a lot of time manually entering the three data items necessary to call up the relevant article in a browser window - Now I find that the "index numbers" or (whatever it is called) has changed;

for Euphoria 4.0.5 --http://openeuphoria.org/docs/std_eds.html#_4203_db_open file:///home/kenneth/euphoria.4.0.3/docs/html/std_eds.html#_4108_db_open [Edited for format - Admin]

So... will the index numbers change with each new version of Euphoria?

Regards,

10. Re: Indexing Euphoria HTML Documentation for context sensitive help

• Posted by K_D_R Jan 26, 2013
• 1559 views

Well, I finally came up with the idea of searching the key_index.html file for search word "hits" and extracting the path to the related *.html file and -hopefully- the best specific article(s). Some command "key words" are re-used in different libraries, and some commands are referenced, or discussed in many different articles, so I use a "maxfile" integer setting to limit the number of *.html "articles" will be opened.

This is rough, even by my standards. Comments, suggestions for improvements will be welcomed.

 
-- 
-- EuHelp.e 
-- 
-- include this file just before the get_escape(boolean help) routine in ed.ex: 
 
 
 
 
 
include std/filesys.e 
include std/text.e 
include std/console.e 
include std/wildcard.e 
 
-- constant BROWSER = "midori --log-file=midori.log  " 
-- constant BROWSER = "dillo  " 
-- constant BROWSER = "google-chrome  " 
constant BROWSER  = "netsurf " 
constant EUDIR = getenv("EUDIR") 
 
constant ONLINE_INDEX_MATCHES_LOCAL = 0  -- FALSE 
                                         -- set to 1, if you have verified that your 
                                         -- local *.html index numbers match those online 
 
-- integer = 0 = offline, use local html files (default),  
-- integer = 1 = online, use openeuphoria.org files. 
 
 
-------------------------------------------------------------------------------- 
-------------------------------------------------------------------------------- 
public procedure EuHelp( sequence word, integer online)  
sequence pattern, HelpFile = EUDIR & SLASH   -- HelpFile starts as: 
			    & "docs" & SLASH  
				& "html" & SLASH  
				    & "key_index.html" -- key_index.html 
 
object line 
integer start_slice, end_slice, wcmatch, hfn, underscore 
integer cont = 1, files = 0,  
	maxfiles = 4  -- maximum number of *.html help pages to display. 
 
hfn = open(HelpFile, "r")  -- opens key_index.html 
while cont do 
    line = gets(hfn) 
    if hfn = -1 then 
	puts(1, "Couldn't open key_index.html\n") 
	abort(1) 
    end if 
    if atom(line) then 
	-- end of file 
	exit 
    end if 
     
    files = 0 
    word = lower(word) 
    line = lower(line) 
    pattern = "*std*"  & word & "\">*" 
    pattern = lower(pattern) 
    wcmatch =  is_match(pattern, line)  
    if wcmatch then 
	start_slice = match("std", line) 
	files += 1 
	pattern = "_" & word & "\">" 
        underscore = match(pattern, line) 
        if underscore then                                                                                     
            pattern = "\">"                                                                                    
            end_slice = match(pattern, line)                                                                   
            end_slice = end_slice -1                                                                           
            HelpFile = line[start_slice..end_slice]  -- HelpFile now = help "article"                          
            files += 1              	 
	 
	    if online then 
--                              online index's need to match local html file indexes.  
--                              Maybe when 4.1 is officially released: 
                if ONLINE_INDEX_MATCHES_LOCAL then 
                    HelpFile = "http://openeuphoria.org/docs/" & HelpFile 
		else 
                    HelpFile = "openeuphoria.org/search/results.wc?manual=1\\&s="&word 
                end if 
 
                ifdef LINUX  then 
                    HelpFile = BROWSER & HelpFile                     
                end ifdef               	        
	    else 
		-- offline, using local std*.html files 
		ifdef LINUX then 
		    HelpFile = BROWSER & "file://" & EUDIR & SLASH  
					    & "docs" & SLASH  
						    & "html" & SLASH & HelpFile 
		elsifdef WINDOWS then                
		    HelpFile = EUDIR & SLASH  
					& "docs" & SLASH  
         					& "html"  & SLASH  & HelpFile	     
		end ifdef 
           end if 
        system(HelpFile, 0) 
       end if 
    end if 
   
     
    if files = maxfiles then 
       cont = 0 
       close(hfn) 
    end if 
end while 
 
end procedure 
-------------------------------------------------------------------------------- 
-------------------------------------------------------------------------------- 
 
 
-- call EuHelp(search_word) in ed.ex's help routine:--------------- 
-- if answer[1] = 'y' then 
				 
-- instead of this line: ----> system(self_command & SLASH & "html" & SLASH & "index.html")    
                    EuHelp(search_word, 0)  -- call the EuHelp function, or: 
                    EuHelp(search_word, 1)  -- to use euphoria.org files online.			 
            else 
		normal_video() 
		end if 
	     end if 
 
	elsif command[1] = 'l' then 
------------------------------------------------------------------------ 
-- export sequence search_word should be defined in syncolor.e 
-- I placed it befor the integer color declarations: 
export sequence search_word = " "  --<-------- insert  -- edx 
integer NORMAL_COLOR, 
------------------------------------------------------------------------ 
-- then, in the function SyntaxColor, insert the following line 
 
	                else seg_flush(NORMAL_COLOR) 
			end if 
			search_word = word --<---------- insert ----- ****** 
			seg_end = last