1. Making Euphoria 4.0 documentation?

  • Posted by ghaberek (admin) Sep 17, 2009
  • 1263 views

Let's say I've got a bunch of files that I've documented in the same manner as the standard library, like this: 

--** 
-- Converts an atom that represents an integer to a sequence of 4 bytes. 
-- 
-- Parameters: 
--      # ##x## : an atom, the value to convert. 
-- 
-- Returns: 
--      A **sequence**, of 4 bytes, lowest significant byte first. 
-- 
-- Comments: 
-- If the atom does not fit into a 32-bit integer, things may still work right: 
-- * If there is a fractional part, the first element in the returned value 
--   will carry it. If you poke the sequence to RAM, that fraction will be discarded anyway. 
-- * If ##x## is simply too big, the first three bytes will still be correct, and the 4th 
--   element will be  ##floor(x/power(2,24))##. If this is not a byte sized integer, some 
--   truncation may occur, but usually no error. 
-- 
-- The integer can be negative. Negative byte-values will be returned, but 
-- after poking them into memory you will have the correct (two's complement) 
-- representation for the 386+. 
-- 
-- Example 1: 
-- s = int_to_bytes(999) 
-- -- s is {231, 3, 0, 0} 
-- 
-- Example 2: 
-- 
-- s = int_to_bytes(-999) 
-- -- s is {-231, -4, -1, -1} 
-- 
-- See Also: 
--      [[:bytes_to_int]], [[:int_to_bits]], [[:atom_to_float64]], [[:poke4]] 
 
public function int_to_bytes(atom x)


How do I go about generating some useful HTML documents from this? I don't see anything in the bin directory that seems to support this. I think such a utility should be bundled with Euphoria 4.0 since this seems to be its "native" documentation format.

-Greg

new topic     » topic index » view message » categorize

2. Re: Making Euphoria 4.0 documentation?

  • Posted by jeremy (admin) Sep 17, 2009
  • 1241 views
ghaberek said...

Let's say I've got a bunch of files that I've documented in the same manner as the standard library, like this:

<snip>


How do I go about generating some useful HTML documents from this? I don't see anything in the bin directory that seems to support this. I think such a utility should be bundled with Euphoria 4.0 since this seems to be its "native" documentation format.

Greg,

We decided on a hybrid approach to distributing this. Here's the deal. EuDOC and CreoleHTML are pretty advanced programs by themselves. We have high hopes for some really cool features added to them. We did not want to distribute them as part of Euphoria as we would like to be able to release them apart from Euphoria. For instance, when we make a bug fix or a feature enhancement to them, we don't want to wait for a full Euphoria release to get them out to the public.

So, what we have decided was that they will be their own "Official" Euphoria project. They live in the /tools directory of our SVN server. They will have their own releases. However, with each major release of Euphoria (4.0, 4.0.1, 4.1, etc...) we will bundle these utilities into the Euphoria installer, thus everyone will have a somewhat up-to-date version, but they are really separate from Euphoria core and can be updated and released outside of the normal Euphoria release cycle.

You need to get tools/eudoc/trunk and also tools/creole/trunk. With eudoc, you can generate a single Creole formatted text file for your project. Then, you can use creolehtml to generate HTML docs from that Creole file. There are other Creole tools, but the one Derek has put together is superior to any other that I have found. We hope that one day from the Creole file we can generate PDF directly, Text Files, OpenOffice and a few other formats (they are all just formatters, they don't have to do the parsing).

Jeremy

new topic     » goto parent     » topic index » view message » categorize

3. Re: Making Euphoria 4.0 documentation?

  • Posted by ghaberek (admin) Sep 17, 2009
  • 1271 views

Excellent, thank you. I will look into that.

-Greg

new topic     » goto parent     » topic index » view message » categorize

4. Re: Making Euphoria 4.0 documentation?

  • Posted by ghaberek (admin) Sep 17, 2009
  • 1248 views

This doesn't seem to be working... 

C:\eu40b1\projects\testing>eudoc testing.ew -o testing.creole 
 
C:\eu40b1\projects\testing>creolehtml -v:1 testing.creole 
Generating 'testing.html' from 'testing.creole' 
Processing: testing.creole 
Processing macros. 
Processing text (9077 bytes). 
Processing: testing.ew


Creolehtml just hangs until I hit Ctrl+C to kill it. What am I doing wrong here? Why is it trying to process the .ew file when I only gave it the .creole file? sad

-Greg

new topic     » goto parent     » topic index » view message » categorize

5. Re: Making Euphoria 4.0 documentation?

ghaberek said...

This doesn't seem to be working... 

C:\eu40b1\projects\testing>eudoc testing.ew -o testing.creole 
 
C:\eu40b1\projects\testing>creolehtml -v:1 testing.creole 
Generating 'testing.html' from 'testing.creole' 
Processing: testing.creole 
Processing macros. 
Processing text (9077 bytes). 
Processing: testing.ew


Creolehtml just hangs until I hit Ctrl+C to kill it. What am I doing wrong here? Why is it trying to process the .ew file when I only gave it the .creole file? sad

-Greg

If you look inside the testing.creole file you'll see a line like ... 

!!CONTEXT testing.ew
This is what is displayed when using the verbose option.

I don't know why it is hanging. Can you send me the testing file to examine?

new topic     » goto parent     » topic index » view message » categorize

6. Re: Making Euphoria 4.0 documentation?

  • Posted by jeremy (admin) Sep 17, 2009
  • 1193 views
DerekParnell said...

dpar8777 ...

Just a FYI, you can allow your email address to be displayed on your Profile page to only authenticated users. Using the method above, many spam bots will be able to figure it out as all sorts of combinations of D O T, DOT, D.o.t, AT (AT) (@), @, etc... have been just applied to a filter. Viewing these messages is allowed by anonymous viewers, but your profile page is protected.

To view your profile, a user must have signed up and answered a reCAPTCHA challenge. Thus, it's unlikely that we will have spam bots harvesting emails from profile pages but it is possible for them to harvest them from this message. Also, this message will be indexed by many search engines, whereas the profile pages will not.

Jeremy

new topic     » goto parent     » topic index » view message » categorize

7. Re: Making Euphoria 4.0 documentation?

  • Posted by ghaberek (admin) Sep 17, 2009
  • 1176 views
DerekParnell said...

If you look inside the testing.creole file you'll see a line like ... 

!!CONTEXT testing.ew
This is what is displayed when using the verbose option.

I don't know why it is hanging. Can you send me the testing file to examine?

Maybe. "Testing" is just a code name for something else I'm working on. getlost I'll see if I can reproduce the problem in a generic file and send you that.

-Greg

new topic     » goto parent     » topic index » view message » categorize

Search



Quick Links

User menu

Not signed in.

Misc Menu