Jump to content

Render options, documentation?


Go to solution Solved by kongondo,

Recommended Posts

Hi,

Its been a while since I dived into PW. I'm still very happy PW being the CMS/F of my choice two years ago of a website I had to transform and maintain. 

Now I am developing a new one and I stumble upon this issue which I solved with some forum search. 

Its good to see the community is growing and a lot new documentation is up since I came here for the first time. Also the developments of PW are exciting! Good work ryan and all others!

But even still I couldn't find the following:

I wanted to render a partial, and I couldnt find any (API) documentation about the $page->render() method. I found in the forum I could give an array of options (['prependFile=>'']) and this worked. So problem solved.

But since I like to see PW grow more, I wonder why is there no documentation about this feature in the docs I could find? Or do I look at the wrong place? If so please accept my apologies. But not at the cheatsheet nor at the docs section nor at the API docs I couldn't even find that render() accepted arguments.

Is there a place where one can drop documentation issues and a documentation team to the rescue? I think we all would benefit if these 'hidden' options would be findable and in one spot instead of just going through the forums to find out that there is even more you can do with PW :)

Thanks!

Link to post
Share on other sites

Thanks for your reply. 
I know there is a lot of info to find on the forums.

What I tried to mention is that I in a way do not get that some basic stuff is pretty good documented in the api docs and cheatsheet and the more conceptual stuff on the docs section, but that this quite basic stuff of methods and its arguments are not to find there. If only it would state that render($options) is available but not yet documented, one can figure out to look in the forums or the source code to see what happens there... Thats what I think would be a good to do since I understand that documentation is a time consuming and not the most popular thing to do...

Link to post
Share on other sites

Sure, could be. Although the docs are much more extended and more up to date than the earliest forum post I found about it accepting the options. But still could very well be.

I dont want to sound like a whining boy who points out what is not right. I know I do but this is not my reason for posting this.

Its mainly curiousity and the question if it is missed on purpose, if one is aware of it and is by choice of is just the way things are to be done...

Dont wanna waste anyones time here.

  • Like 1
Link to post
Share on other sites
  • Solution

@jtborger,

You are not wasting anyone's time. The fact of the matter is that overall, there is still a lot of room to improve ProcessWire's documentation and tutorials across a range of topics spanning both basic and advanced stuff. It is something we are aware of and are keen to improve. Part of the Road Map for 2016 is exactly that...'continued and greater focus on documentation and tutorials'. Of course this does not mean everything will be done and dusted by the end of play 2016 but there should be some positive advances nevertheless.  Whilst there are some great examples in the forums regarding various uses of the ProcessWire API, those cannot and should not be considered as a long term solution in lieu of proper documentation. In the meantime though, they are a good place to start if you are searching for particular answers.

Welcome back to the forums :-)

Edited by kongondo
  • Like 6
Link to post
Share on other sites

Thanks Kogondo for your answer and the welcome back.

Great that it is a focus point for this year. I sure do understand the limits of these goals and also the great value of the forum for more advanced usage examples. But this render($options) thing seemed so obvious fundamental to me that I wanted to know what was going (or not) on about it in general.

Is there a place to file 'doc' issues or is it too early for that?

I'd like to turn my 'effort' from investigating 'why hasnt this not being done yet' to something more proactive and positive.. :) instead of just sort of being grumpy ;)

  • Like 1
Link to post
Share on other sites

The render method is relatively new and only available since the 3.0.5 dev version. (current version = 3.0.8)

It's nicely explained by Ryan in the 3.0.5 + 3.0.7 release posts: 

https://processwire.com/blog/posts/more-repeaters-repeater-matrix-and-new-field-rendering/#processwire-3.0.5-introduces-field-rendering-with-template-files

https://processwire.com/blog/posts/processwire-3.0.7-expands-field-rendering-page-path-history-and-more/

Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    No registered users viewing this page.

×
×
  • Create New...