We launched new forums in March 2019—join us there. In a hurry for help with your website? Get Help Now!
    • 32319
    • 129 Posts
    I have started going through each of the API functions and variables one-by-one to better understand the foundation of MODx and I figured while doing this I would put what I learn into the API wiki since it is largely empty.

    There are some holes though, at times I have trouble figuring out the best definition or may be missing a key piece of information so I encourage others who have a strong understanding of the API to trail along behind me and fine-tune/correct any holes and mistakes. It should be pretty easy since I am doing the bulk of the busy work by adding the template and general info.

    Also, please let me know if anyone would like to see things done differently. Right now I am working on the variables (started at the top) and there was only one variable defined so I used its template. Now would be a good time to give any ideas for additions to the template before they are all populated.

    My hope is that once the template and basic information is inserted, it will be easier for people to add and refine the API (which should help the development effort in general).

    Also, if anyone else has a desire to jump in on this and is using BBedit, I have started a package of clippings to make filling out the raw templates fairly easy. Let me know and I provide them.

    I have started on the DocumentParser API here:
    http://wiki.modxcms.com/index.php/API:DocumentParser
      "Regret for the things we did can be tempered by time; it is regret for the things we did not do that is inconsolable."
      -- Sydney Harris
      • 27376
      • 576 Posts
      This sounds great Whitefen! I started writing code for all the methods on the API Pages but then stopped when I heard of 0.9.7’s major overhaul. I figured I’d wait until 0.9.7 is released. But since most people will be using the current version of MODx it would propbably be a good idea to have both versions documented...
        • 7923
        • 4,213 Posts
        Yes, it’s definitely worth doing this for the current code base, 0.9.7 has still long way to go (although there will be public alphas and betas pretty soon after 0.9.6).

        So, keep on going, looks great!


          "He can have a lollipop any time he wants to. That's what it means to be a programmer."