OpenEuphoria

1. How to suggest edits to the manual?

• Posted by dcuny Feb 03, 2015
• 1382 views

I've noticed a number of places (graphics, pseudo-memory) that the Euphoria manual is rather sketchy.

What's the process for suggesting changes to the manual?

- David

3. Re: How to suggest edits to the manual?

• Posted by dcuny Feb 03, 2015
• 1381 views

Thanks, Jim. Let me be a bit more specific, and say that I want to submit an updated version of Pseudo Memory, with a bit more text to explain what it's about, as well as some examples.

Do I rewrite it using Creole markup, and post that as a ticket? Obviously, it could be a fairly large post.

Or is some other markup language preferred?

Thanks!

- David

5. Re: How to suggest edits to the manual?

• Posted by _tom (admin) Feb 03, 2015
• 1328 views

Improving the documentation--official process:

• Complain (loudly)
• Allow for response using geological scale time delay
• Write an outline of some suggested changes
• Enter a formal ticket (to keep ideas and complaints from getting lost)
• Write out some suggested copy
• Add something to the wiki, and refer to it in a forum post
  • This will allow some interactive editing

You can ignore Creole formatting...I will do it for you. If you want to use creole I'm starting to establish a standard. But, best not to waste energy fussing over formatting at this time.

• Use creole = == === to suggest some heading levels (correspond roughly to html <h1> <h2> <h3> )
  • Headings will be mostly for your own organization, the manual may differ.
• I'm now using creole bold to define important words followed by a definition.
  • A bmp is "a Microsoft format for pixel based graphics images."
  • These definitions to be extracted and added to an index.
• Use creole / / / / italics for emphasis.
• Use creole <eucode> and </eucode> to enclose Euphoria source-code

• There is no value in using \ \ line breaks. They are only useful in the final edition of the manual.

---

I have broken (literally) the documentation into smaller files. It will be easier to keep each topic to one small file rather than the monsters that exist now.

• eudoc collects the small files and makes one master file
• creole converts this text file into html
• wkhtmltopdf converts html into a pdf

If someone wants a TeX formatted pdf then they are in charge of that project.

---

Example bmp

You have not been ignored but:

You know more about the bmp format than I do. Last time I used bmp format was with Windows 3 or 4. Euphoria documentation on bmp dates roughly to that era.

Since Windows 8 and Windows 9 have not been successful I was optimistic that no-one would mention bmp format.

Sorry I did not respond faster...

_tom

my_spot = malloc(1,0) 
 ram_space[my_spot] = my_data 
     -- . . . do some processing  . . .  
 free(my_spot) 

7. Re: How to suggest edits to the manual?

• Posted by _tom (admin) Feb 03, 2015
• 1323 views

Yes, an include file is documented with the source-code itself. The eudoc program extracts the documentation and combines it with stand-alone files to make that monster final product.

I'll do the grunt work of editing the include file and uploading to the SCM mercurial repository.

That is why creole formatting is optional and a contributor doesn't have to fuss over what they write.

Much appreciated.

'Pseudo' is for "internal" use, not 'C' memory for generic interfacing.

Pseudo memory is what makes map.e and stack.e work.

This is clever/tricky stuff that I'm not ready to start documenting...help?

_tom

9. Re: How to suggest edits to the manual?

• Posted by _tom (admin) Feb 03, 2015
• 1295 views

I describe peudo memory as "tricky/clever" because I have no simple way of explaining it.

Suggest some alternative language and descriptions. Then we look at it and see if improves things.

_tom