World: r4wp
[#Red Docs] How should Red be documented
older | first |
NickA 6-Dec-2012 [91x2] | The online REBOL dictionary and the Word Browser are both effective formats for cross referencing. Something like Carl's REBOL manual is essential to get things started. |
A wiki seems like the best way to get community help collecting examples of function use. | |
Arnold 6-Dec-2012 [93x2] | A wiki lowers the barrier to contribute, best would be if it were possible to import the added pearls to the 'official' docs. |
Don't know if you know http://learnyousomeerlang.com/and where it was derived from http://learnyouahaskell.com/that kind of a site would be cool for REBOL/Red. | |
Henrik 7-Dec-2012 [95] | Should this group not be public? |
DocKimbel 7-Dec-2012 [96] | No problem for making it public. |
Henrik 7-Dec-2012 [97] | Not sure if this is enough. Changed the title. |
Gregg 9-Dec-2012 [98] | On docs, in one of my dreams, I see another category along with Example and See Also: Tests. Make it easy for people to contribute tests (and expected results). |
AdrianS 9-Dec-2012 [99] | Agree that examples are a must have. I see way too many reference sites that just show an API along with a brief description. Even when these are very nicely presented, they leave me wanting. Seeing an APIs in action makes a huge difference to me, but of course the work of creating examples should come from the community. |
james_nak 12-Dec-2012 [100] | Gregg, that's a good dream and very meaning for learning. The figuring out of why something doesn't work is so powerful especially when one thinks it should. |
Chris 11-Jan-2013 [101x2] | <from #Red> |
A document would be trickier as you'd need to manage line spacing, paragraph spacing, splitting paragraphs/docs over pages. | |
Henrik 11-Jan-2013 [103] | Yes, it managed only a single page, and yes, the hard part is flow of paragraphs across pages, not generating multiple pages in itself. |
Chris 11-Jan-2013 [104x2] | (that'd be page breaks, indeed) |
You'd need to be able to measure as you go... | |
Henrik 11-Jan-2013 [106x2] | I'd still think that doing it in the graphics engine is simpler than in PDF. For R3, someone is probably going to do it anyway. |
and I hope DRAW or similar will be available for Red. | |
Kaj 11-Jan-2013 [108] | It will |
Henrik 12-Jan-2013 [109] | cool :-) |
Pekr 12-Jan-2013 [110] | Kaj - sounds like sure thing but also news for me :-) AFAIK you and Doc were not much interested in bringing View to Red. Well, unless you mean DRAW equivalent done using different engine ... |
DocKimbel 12-Jan-2013 [111:last] | Pekr: DRAW is a dialect for 2D vector drawings. |
older | first |