Document all template helpers in a "cheat sheet"

[fredrikekelund]

I want to preface my small complaint by saying that the Apostrophe docs are some of the best technical docs I've ever seen. Well written, widely encompassing and well maintained. But there's always room for improvement!

Template helpers in Apostrophe have sometimes confused me a little bit. The fact that they are all namespaced under the apos variable initially lead me to believe that I was interfacing directly with the main apostrophe instance. Once you realise that's not the case, there's still no way of easily inspecting that object (you can't console.log it and you can serialize it to JSON). The module reference documentation does contain details on which template helpers the different modules register, but there's no central reference of which template helpers that the apos object contains.

It would be very helpful to have a central reference like that, a "cheat sheet" if you will. This would also make it easier to not have to look up the aliases of the different modules - ie. areas in apos.areas.richText()

[boutell]

Yes, we really ought to build a concordance of all of the helpers on a single page with the same tool that builds the module-specific documentation for them.

…

On Sun, Jun 10, 2018 at 8:16 AM, Fredrik Ekelund ***@***.***> wrote: I want to preface my small complaint by saying that the Apostrophe docs are some of the best technical docs I've ever seen. Well written, widely encompassing and well maintained. But there's always room for improvement! Template helpers in Apostrophe have sometimes confused me a little bit. The fact that they are all namespaced under the apos variable initially lead me to believe that I was interfacing directly with the main apostrophe instance. Once you realise that's not the case, there's still no way of easily inspecting that object (you can't console.log it and you can serialize it to JSON). The module reference documentation does contain details on which template helpers the different modules register, but there's no central reference of which template helpers that the apos object contains. It would be very helpful to have a central reference like that, a "cheat sheet" if you will. This would also make it easier to not have to look up the aliases of the different modules - ie. areas in apos.areas.richText() — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#101>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAB9fYwcrQU4woy0_iJA09W7rWpdN4f5ks5t7Q4PgaJpZM4UhsVX> .

-- *THOMAS BOUTELL, CHIEF SOFTWARE ARCHITECT* P'UNK AVENUE | (215) 755-1330 | punkave.com

[boutell]

We do have a page with all of the nunjucks filters but that list is much shorter.

…

On Mon, Jun 11, 2018 at 8:22 AM, Tom Boutell ***@***.***> wrote: Yes, we really ought to build a concordance of all of the helpers on a single page with the same tool that builds the module-specific documentation for them. On Sun, Jun 10, 2018 at 8:16 AM, Fredrik Ekelund ***@***.*** > wrote: > I want to preface my small complaint by saying that the Apostrophe docs > are some of the best technical docs I've ever seen. Well written, widely > encompassing and well maintained. But there's always room for improvement! > > Template helpers in Apostrophe have sometimes confused me a little bit. > The fact that they are all namespaced under the apos variable initially > lead me to believe that I was interfacing directly with the main apostrophe > instance. Once you realise that's not the case, there's still no way of > easily inspecting that object (you can't console.log it and you can > serialize it to JSON). The module reference documentation does contain > details on which template helpers the different modules register, but > there's no central reference of which template helpers that the apos > object contains. > > It would be very helpful to have a central reference like that, a "cheat > sheet" if you will. This would also make it easier to not have to look up > the aliases of the different modules - ie. areas in apos.areas.richText() > > — > You are receiving this because you are subscribed to this thread. > Reply to this email directly, view it on GitHub > <#101>, > or mute the thread > <https://github.com/notifications/unsubscribe-auth/AAB9fYwcrQU4woy0_iJA09W7rWpdN4f5ks5t7Q4PgaJpZM4UhsVX> > . > -- *THOMAS BOUTELL, CHIEF SOFTWARE ARCHITECT* P'UNK AVENUE | (215) 755-1330 | punkave.com

-- *THOMAS BOUTELL, CHIEF SOFTWARE ARCHITECT* P'UNK AVENUE | (215) 755-1330 | punkave.com