Development Blog

Looking good and the idea of comprehensive examples sounds good to me.

Is there any way that members only could add to a wiki?

Instead of chm files, why not just plain html files that open in any browser on any platform? You don't need to have them on HTTP servers if the contents don't change.

 

It counted as a "manual" as far as Quake 3 was concerned, and that was the first time I really saw it done.

Instead of chm files, why not just plain html files that open in any browser on any platform? You don't need to have them on HTTP servers if the contents don't change.It counted as a "manual" as far as Quake 3 was concerned, and that was the first time I really saw it done.

Wikis are much easier to edit. The table of contents is handled automatically, and internal links can be added just by surrounding a work with [[brackets]]. It probably would take three times longer to edit all that HTML, and every change would be painful. Plus, people want to be able to search them and not everyone will think to use Windows search (I think they messed it up in recent versions, too...one more reason I prefer XP. ).

 

Is there any way that members only could add to a wiki?

I would have to create all accounts manually. Apparently there was at one time a bridge for IPB and MediaWiki, but I am not sure if it works. Then there is the issue that I have to be able to answer all questions about these docs, and if it's something a user added, I might not be up to date on that knowledge.

I would strongly suggest keeping the 5 or 10-line examples (those that don't overlap, at least). It's very valuable to have quick function information at my fingertips and to not have to wade through dozens of lines of unrelated code and documentation just to (hopefully) find and understand how a function is used. The more information that's presented, the more likely it is to not be understood.

 

That said, I'm sure I and others will find the comprehensive examples informative and helpful as well.

That makes sense to me. It's kind of silly to have a full page of code just to demonstrate Entity::SetMaterial or something like that. If you look at the Vec3 operators, I made small examples that aren't entire self-contained programs. Sometimes I need to stop being so pedantic about everything.

..im seconding what gamecreator said..few lines of example code with each parameter description is way to go..also, i hope that under 'programmers' expression, you primarly thinking on people whos using raw C++, C# and Bmax, rather than scripting language..having said that, i also hope that system will be fully available in fashion as current LE is, because to me personally, none of future editors has any value , because from my experience i have so far, most of tasks i needed to perform, and requests from artists, were way way beyond offered toolset capabilities (not just LE, but Phyre library as well) , so i would like to be able to build my own tools from scratch for certain targets .. i really hope for this things because im planing to use LE 3 fully on mobile devices + mac .. if not..then..ill have to say good bye..

i also hope that system will be fully available in fashion as current LE is

Yes, don't let my positioning of it as a "visual game design tool" scare you. You've still got an API-oriented engine under the design layer. I'm just adding a layer of control designed for people who don't want to program. Who knows, you might even find it useful for some tasks.

 

i hope that under 'programmers' expression, you primarly thinking on people whos using raw C++, C# and Bmax, rather than scripting language

I think C++ is the best language to document things in, because it is a standard everyone can follow along. I can't really write syntax descriptions in Lua since all variables have no type. It's easier to convert a C++ examples into C# or Blitz or Lua than it is to go from another language to C++.

need a web designer?

Consider many users now use ipads and such for reading, the best way to do it would be an xml /database based documentation being exported to html (with a download full html documentation link) and pdf. There are a number of tools to do that we use in our company if you need help on that.

 

As long as tutorials go I really love the style of this book

Essential C++

 

also introduced with some examples here

http://www.entish.org/realquickcpp/realquickcpp.html

 

After reading several C++ books (I come from C#) I really like the approach, it gives a full tutorial with cleverly thought of in depth examples for real world cases.

I also agree with GameCreator. Short examples for all functions. You'll be able to use the same example for a bunch of different functions in some cases

I agree with Game Creator as well, some concise examples demonstrating all the parameters of a specific command without all the initialization fluff that is cluttering some now. Personally I don't really care in what shape or form we will eventually have them, as long as they're thorough and complete.

You might want to check some Mediawiki plugins that are made to prevent spam (captcha codes etc.).