PrevThe New ProcessWire 3.x API Reference
This week we have the beginnings of the ProcessWire 3.x API documentation ready and published. This post goes more in depth about how it's powered and what's left to do. More
ProcessWire 3.0.16
Last week I mentioned we'd be continuing the documentation updates into this week and that's exactly what we did. So rather than writing a lot about it here, I'd encourage you to go check it out, as that's where all the writing is this week! And actually, it was quite a lot! But I'll give you a summary here.
All in all, these documentation updates involved 46 files and 5264 additions, so far. That's a lot. It's the first time I think that I've had GitHub tell me that a commit was too large to display.
ProcessWire core classes now in API reference
Last week I tried to get the main API variables covered. This week those were wrapped up, and then work on the most important core classes commenced. If you go look at the ProcessWire 3.x API reference, you'll now see more than 20 of the most used core classes now fully covered. Here's a few examples of what you might find…
- Ever wondered what the core Wire class does?
- Ever been curious about all that you can do with a WireArray?
- Not totally clear on what a NullPage is all about?
- Any questions on what makes a Module a Module? (there's a lot to see here)
- Ever needed a comprehensive list of methods, properties and constants available for an Inputfield or InputfieldWrapper?
- Ever wondered what all the various methods in a Fieldtype were for?
- Interested in what you can do with WireHttp?
- Curious about some of the fun tools available in WireArray?
You'll find all this, and much more in the latest ProcessWire 3.x documentation updates.
ProcessWireAPI module update expands and improves output
Beyond the documentation updates to the core itself (which are now committed in 3.0.16), a lot of work also went into improving the ProcessWireAPI module which is parsing and outputting all the documentation. Here's just a few of the improvements below.
It can now display more extensive class documentation, like you see here for Module interface. This is all coming from Markdown in PHP comments directly in the core code. This enables us to really improve the documentation not just at the method level, but at the overall class level too. Last week our documentation was primarily limited to class methods.
There's now a "quick jump" select that lets you jump to anywhere in the API reference very easily. There's a lot of material in the API reference, so figured we needed something like this.
Last week a couple people asked about @since phpdoc support, which was in place, but not yet used for output. It's been enabled, and the requested changelog support has been added as well. Since there's no phpdoc @changelog tag (that I could find), we're instead using a #pw-changelog tag. You'll see both @since and #pw-changelog in use for this method, as an example.
There's lots more too, but stop reading and head on over to the 3.x API reference. :) Please let me know if you spot any output issues along the way. Yes, there's still a lot more to cover in terms of core classes, but I think we've got the most used and most important ones pretty well covered now. I'll be continuing to add more and more though, this will be an ongoing process. Please let me know if you spot any major holes, or any additional classes you'd like to see here in the next updates.
Comments
NextProcessWire 3.0.17 brings major upgrade to images field
6 May 2016 11
ProcessWire’s images field has been re-designed and redeveloped with a lot of great new features we think you’ll love! This post covers it in detail. There’s also a screencast at the end that shows you the new images field in action. More
Nico
Awesome :)
Reply
Joshua gatcke
- 9 years ago
- 20
★★★★★Amazing work! This is really helpful.
Reply
Yannick Albert
- 9 years ago
- 10
★★★★★Wow, just wow!
Reply
pwFoo
- 9 years ago
- 00
★★★★★Build great documentation will help to reach the next level with PW ;)
Reply
Adrian
A great doc is exactly what this superb project needed !
Thanks.
Reply
Antti
Amazing work with the documentation Ryan!
Are you planning to release the ProcessWireAPI module or is it build just for PW documentation?
Reply
can
- 9 years ago
- 10
★★★★★Awesomenessss!!!
Multi-instance is only missing documentation (think that's what I read somewhere) really curious to try out :D
Think I could use it in at least one project..
Saludos
Reply
Miguel
Amazing! Cannot wait for the Selectors new documentation!
Reply