Howdy, Stranger!

It looks like you're new here. If you want to get involved, click one of these buttons!

Discussing the Wiki

edited November 2011 in Wiki Posts: 2,161

Along with the Issue Tracker, we have a wiki. I made a start on the main page by creating a table of contents with pages that I thought might be useful. I haven't created any of those pages as yet, though.

It's a wiki, so edit and add stuff. I recommend that major changes be logged in the forum here (if the wiki takes off, maybe we should have a wiki-specific category).

Comments

  • BortelsBortels Mod
    Posts: 1,557

    I added an "OtherResources" page, and copied the FAQ over.

    I am also thinking of adding a "projects" page, where people can put a link in to their projects that they're sharing - the forum here is getting difficult to find things in.

  • At first there will be a flurry of updates as we get the structure down and add the intial content together. As far as my default personal style, I tend towards frequent small updates with small (expect for lists) which means many pages. Whatever styles or recommendations are made here, I'll follow. For instance I'll stick with the TOC mentioned above. However, I think I will add some kind of "how to contribute" link to the TOC. It wasn't obvious that one had to join to be able to edit. I'll keep the forum updated what I'm up to. As you say, after a time, we won't need the forum for day to day coordination.

  • If I understand correctly, this is a limited wiki. I can't appear to access updated that I've made that we're removed by others at my level of access.

  • BortelsBortels Mod
    Posts: 1,557

    My two cents is that the more we get into the wiki, the better well be, especially at first. As the active user base grows, things like voice will bug some more than others, and they'll fix it.

    I would like to see a page there with the devs future intent - no guarantees, of course, but a list of requested features as they understand them, along with "upcoming" or "planned" or "will not do", and perhaps reasons, would help eliminate some churn in the forums. Perhaps that's in the issue tracker, dunno.

    I do plan on putting my own stuff up in the wiki, both in some sort of project list, and on a "personal page". Knowing something about the others here humanizes them and may reduce friction.

  • Posts: 2,161

    I made a start on the "Getting Started" with a short program. I couldn't get the hang of the formatting (particularly putting code inside a list), and I need to add screenshots once I get them off my iPad.

    My intention was then to have a bit on how Codea builds up an animation, I started it, but then I was going to put something about the frame buffering only I couldn't get it straight with some simple examples! So I (or someone) needs to figure out some straightforward examples that show the frame buffering in action and how to get round it.

  • DylanDylan Admin Mod
    Posts: 121

    The frame buffering will be much easier to fix in the update after next, there is a call which will turn it into something like single buffering. It slows the iPad 1 down a lot though.

    I like the idea of putting our plans, and general philosophy when it comes to feature requests up on the wiki.

    @ipda
    Im not sure what you mean by "changesets". If you mean the git commits, we intend to keep that closed for now, with a plan to open up the backend and release a demo game with source code that uses it. This could be a while though.
    Its probably a good idea to put any interesting nuggets you find on the forums into the wiki. I'm not sure what you mean by #occupyapple.

  • changesets - are something referred to in the bitbucket wiki that can be linked to, I assumed that they mean builds or releases but am not familiar with bitbucket.

    (#occupyapple - a puerile reference to #ows to get apple to approve the next codea release :-D )

  • DylanDylan Admin Mod
    Posts: 121

    Ah, I thought you were referring to #ows, but didnt know how it related :)

    Changesets would refer to git commits, which we aren't exposing publicly for now, so they probably won't be too useful.

  • Posts: 2,161

    The wiki syntax is extremely restrictive as far as I can see; in particular, I can't see how to have more than one paragraph in a list (<br/> just ain't the same). Making a virtue out of a necessity, I've put the initial tutorial on its own page and used headers instead of list elements.

    I've also listed a load of other tutorials that I think would be good to have.

  • Relinked parameters back into the new structure

  • Posts: 2,161

    I've added screenshots to the first tutorial, and the "full code" (not that there was a lot!).

  • Posts: 2,161

    NB I just uploaded the screenshots to picassa and then linked them. I'm not sure what the best solution is for having screenshots to ensure that they persist.

  • SimeonSimeon Admin Mod
    Posts: 5,054

    Very nice tutorials! With regards to the images, I will look at re-hosting them on twolivesleft.com and re-linking them in the wiki.

    I've added a page for user libraries https://bitbucket.org/TwoLivesLeft/codea/wiki/Libraries

  • edited November 2011 Posts: 622

    @Andrew looks great

    The last code snippet has the same as the prior one

    ellipse(WIDTH/2,HEIGHT/2,100) should be ellipse(x,y,100) from earlier, yes?
    

    Didn't know if you wanted me to change it.

  • I think with https://bitbucket.org/TwoLivesLeft/codea/wiki/Parameter and https://bitbucket.org/TwoLivesLeft/codea/wiki/AnimationTutorial they are set up to understand the ellispe modes, parameters, and line examples in the application.

    Should we submit a version of the lines example with comments?

    Should we just point them back to the examples from the wiki?

  • SimeonSimeon Admin Mod
    Posts: 5,054

    I would be happy to include an improved example in the next version.

  • Posts: 2,161

    @Ipda41001: cut-and-paste error. You should feel free to change things, especially when they're obvious like that.

  • added http://twolivesleft.com/Codea/Reference to main page

    I wasn't sucussful in finding a way to covert/display JSON to basic HTML on the fly, externally

  • Added https://bitbucket.org/TwoLivesLeft/codea/wiki/CodeaMain

    a brief discussion on the relationship between the functions that Codea calls.

    Requires fact checking by TwoLivesLeft.

  • Posts: 273

    I've offered to add to the wiki two very helpful code examples that Simeon provided in response to my questions -- the DragMe class example and the Scenery class example. Now the problem is where to put them. Looking at the wiki I propose to link them from the existing 'HintsAndTips' page (which sacrebleu! I see already sports links answering my next two questions (1) on Codea structure and (2) on the whys and wherefores of vec2's!).

    Good? If anyone feels they belong elsewhere please don't hesitate...

  • Posts: 2,161

    Just because links exist doesn't mean that pages do. I put in a load of links to pages that I thought ought to exist. Many pages are blank so click through before you assume that one exists.

    If you have something to put on, the main thing is to put it on. We can reorganise it afterwards if it needs it, but it's easier to do that when we can read what you intend to write.

  • Posts: 2,161

    (Oops, really should read all the threads before posting. I see that Ipda1824913508431 has posted something about vec2)

  • edited November 2011 Posts: 273

    I have updated the 'Hints and Tips' section of the wiki with two code examples posted here on the forum by Simeon (and Simeon agreed could go to the wiki). I hope the examples help others as much as they helped me.

    The Draggable Rectangle (DragMe Example)

    https://bitbucket.org/TwoLivesLeft/codea/wiki/dragMe

    Distributing Code Over Tabs Example

    https://bitbucket.org/TwoLivesLeft/codea/wiki/tabCode

  • SimeonSimeon Admin Mod
    Posts: 5,054

    Thanks @Blanchot for contributing those pieces to the wiki! Note that you don't need my permission to use anything I post here :)

  • Copied Feras' tutorial next to @brab's in getting started

  • beebee
    edited December 2011 Posts: 381

    I think the wiki and bug tracker need to be mentioned on the main page of Codea here: http://twolivesleft.com/Codea/ so new comers could find them since the first visit.

  • beebee
    edited December 2011 Posts: 381

    I also think we need some kind of Project Gallery or something on the wiki to show off users' creation. Can we attach files (.codea file it is) and images to the wiki? I propose each project need to show/mention the author, a brief description, screenshot(s), link to github or pastebin (if available), and .codea project file. See template example here. What do you think?

  • Posts: 489

    Hello. I am new to Codea. Is the documentation of its class() function currently the discussion on Class Inheritance? and the file Class.lua? May I transfer that information to a new page on the wiki?

  • SimeonSimeon Admin Mod
    Posts: 5,054

    That would be wonderful @mpilgrem, thank you.

  • Posts: 489

    I have made a start in page CodeaClasses and linked the home page to it.

  • IgnatzIgnatz Mod
    Posts: 5,396

    I am new to Codea, with a background in several other languages, and I just love the thought that's gone into the editor and the tutorials. They're by far the best and clearest I've ever seen, and I'm really looking forward to exploring Codea further. Thank you so much!

  • Pi think the wiki needs a revamp with more tutorials
    Also I am new to lua too with the same backstory as ignatz

  • Posts: 1,976

    A. This thread is ancient, try not to bump it...

    B. @Ignatz isn't so new anymore... :P

  • IgnatzIgnatz Mod
    Posts: 5,396

    @TheRoguebatcher - I have written nearly 150 tutorials and several ebooks, and others have written plenty too isn't that enough for you?

Sign In or Register to comment.