Orkun

Unified Documentation Resource for Processwire

Recommended Posts

Hi Guys

It would be awesome when all the resource about processwire (tutorials, docs, cheatsheet, recipes, videos, api, faq etc...) would be unified on one documentation website called "docs.processwire.com".

The new site would gather infos & data from these resources:

and would unified it on the final site https://docs.processwire.com.

I think It is far more better to have one endpoint for all the processwire resources & wisdom then mutliple sites. This way it is far more easier to get into the processwire world and choosing processwire as the next main cms for further projects.

 

The Documentation Site could perhaps look like this (it is just a mockup, so don't expect to much from me :D ):

5a43a62f462a1_Bildschirmfoto2017-12-27um14_38_41.thumb.png.9b1e39ae30548ce9d876c82c9e68ac38.png

 

  • Like 9

Share this post


Link to post
Share on other sites
6 hours ago, Nukro said:

It is far more better to have one endpoint for all the processwire resources & wisdom then mutliple sites

Sure. The issue is that there is more. For example the Blog is also full of organized info. At least one blog post is organized... but the all the blog posts as one entity is not really.

Maybe one an endpoint which is actually a search feature that can search them all at once?

Merging all this stuff looks like a mighty task.

Share this post


Link to post
Share on other sites
15 minutes ago, szabesz said:

Merging all this stuff looks like a mighty task.

Yes. Yes, it is. And the longer any organization is put off the mightier that task becomes.

  • Like 2

Share this post


Link to post
Share on other sites
11 minutes ago, rick said:

And the longer any organization is put off the mightier that task becomes.

I couldn't agree more :) Maybe that is why I already proposed:

https://processwire.com/talk/topic/17348-is-pw-becoming-more-popular/?do=findComment&comment=150914

"...I propose to make 2018 the year of the documentation, so to speak. What if we could stop hunting for new features for a while and concentrate on the following in 2018..."

  • Like 4

Share this post


Link to post
Share on other sites
14 hours ago, Nukro said:

Hi Guys

It would be awesome when all the resource about processwire (tutorials, docs, cheatsheet, recipes, videos, api, faq etc...) would be unified on one documentation website called "docs.processwire.com".

2

In reality, the unified and structured content can be implemented in the corporate world, not really in the opensource community.

In opensource community anyone only able to devote a few hours of their times, but it's already a valuable knowledge for someone else.

Internet technology taught us to change our mindset from structured to unstructured content. From centralised to distributed information. The search engine and bookmark technology help us to manage the unstructured content on our part.

  • Like 4

Share this post


Link to post
Share on other sites

In addition to what already has been said in this thread, I'd like to add this:

Of all open-source projects I ever came across, PW is very well documented. I've seen commercial apps which are documented far worse.

Can it be improved? Certainly.

Will it ever be 100% complete and perfect - and suit everyone? I don't think so.

But I found that I can easily get most infos with a "keyword site:.processwire.com" Google query. Building your own bookmark collection helps. Keeping up-to-date by signing up to the PW newsletter helps as well. Digging into the source code helps too (as @bernhard recently has shown with his module-tutorial, there are true treasures buried right inside core code).

Having said all that, maybe it would be worthwhile to try and build a Google CSE (custom search engine), which should be free to use for non-commercial / open-source communities, at least last time I checked.

That's not to say I would oppose a unified docs.processwire.com project; but the effort is not to be under-estimated.

 

  • Like 2

Share this post


Link to post
Share on other sites

still i find chromes search shortcuts the best option - at least if you know where you want to search for your term...

custom search for "custom admin"... lots of annoying ads (yes, i know you can "turn them off"...)

5a4d0f26ae069_2018-01-0318_09_31-BenutzerdefinierteSuchevonGoogle.thumb.png.4bab4f72e65f45e6765b8bea9b3488b9.png

search "pw custom admin"

5a4d0f203ed1b_2018-01-0318_11_05-site_processwire.comcustomadmin-Google-Suche.png.2291ac8ce4f80ceec577c6d94516c47a.png

and finally searching in the blog: "blog custom admin"

5a4d0f1e2ba1b_2018-01-0318_12_13-site_processwire.com_blogcustomadmin-Google-Suche.png.ebfe018277c0def1a7591dcd394d0a86.png

But maybe for newcomers such a search can be helpful (though I think someone already built one some time ago...) ;)

Share this post


Link to post
Share on other sites

Sure. But having a search that crawls several domains/sites in one go is surely a plus.

And frankly, there is no reason not to have uBlock installed and running :)

Also, since I switched from Chrome to Firefox Quantum recently, I realized there's apparently still no way to add a custom search like pre-Quantum (right inside the search/location field) with a keyword, like in Chrome. But I guess I'm nerding out now so I'll shut up.

  • Like 1

Share this post


Link to post
Share on other sites

I think one way possibly to encourage more unified documentation would be to allow user comments on official documentation like PHP documentation or MSDN.

Currently it appears that there's no way to comment on official documentation, and that encourages fragmentation, as you either have to post in the forums or on another site.

I understand moderation might be an issue, as questions belong in the forums, not in the official documentation, but user contributed examples and tips would make sense as comments with the official documentation.

Comments allowing links could also refer to relevant threads in the forums or external articles to avoid having to reinvent what's already available.

The official modules directory already allows comments, so presumably it wouldn't be too hard to add something similar to documentation?

  • Like 2

Share this post


Link to post
Share on other sites
5 hours ago, Kiwi Chris said:

I think one way possibly to encourage more unified documentation would be to allow user comments on official documentation like PHP documentation or MSDN.

We have already discussed it, this idea got some "likes" too: https://processwire.com/talk/topic/11998-growing-processwire-in-2016/?do=findComment&comment=111499

5 hours ago, Kiwi Chris said:

I understand moderation might be an issue

If it is possible to check this forum's data then it would be possible to give edit rights to only certain forum members based on that, for example.

  • Like 1

Share this post


Link to post
Share on other sites
15 hours ago, szabesz said:

If it is possible to check this forum's data then it would be possible to give edit rights to only certain forum members based on that, for example.

That would be a good model. If only people with a certain level of contribution could post comments, that would likely prevent new users coming along and posting questions on the documentation site.
Stack Exchange uses reputation based management to restrict some activities and responses I think, and the model works well there.

  • Like 1

Share this post


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.

  • Similar Content

    • By DamegoGmbH
      Hi there,
      we are a small Communication Agency in Munich and we are searching for a Processwire Developer.
      A lot of our Online Projects are based on Processwire and our current Developer is switching from Freelance to a full term job.
      The work can be done remotely from anywhere.
      For more Informations please contact me directly via Email: p.kirschvink@damego.de
      Looking forward to hear from you.
      Best
      Paul
    • By karian
      Hi, based on the work of @microcipcip and @gebeer  (see their posts here and here), I put together a Processwire + React boilerplate (profile).
      Github repo: https://github.com/lapico/process-react

      Cheers,
      K
       
    • By Sephiroth
      Hi, So today I will writing a small tutorial on developing templates in Processwire using Twig Template, Processwire is a highly flexible CMS which gives developers/designers/users options and allows easy extension of the platform. So here goes the tutorial 
      What is Twig Template ?
      Simply put in my own words, Twig is a modern templating engine that compiles down to PHP code, unlike PHP, Twig is clean on the eyes , flexible and also quite *easy* to have dynamic layout site with ease ,without pulling your hair out. Twig is trusted by various platforms. It was created by the guys behind Symfony.
      Take this code as an example
      {% for user in users %} <h1>* {{ user }}</h1> {% endfor %} This will simply be the equivalent in PHP World
      <?php $userArray = ["Nigeria","Russia"]; foreach($userArray as $user): ?> <h1><?= $user ?></h1> <?php endforeach; The PHP code though looks simple enough however, you start to notice that you have to be concerned about the PHP tags by ensuring they are closed  properly , most times projects gets bigger and comes complex and harder to read/grasp, and also in PHP you can explicitly create variables in the template making it very hard to read as it grows and prone to getting messy WordPress is a major culprit when it comes to that regard.
      Have you ever wanted to created separate layouts for different pages and  break your sites into different parts e.g Sidebar, Comment Section, Header Section ? the regular approach would be to create individual pages for each section and simply add them as templates for the pages and with time, you can end up having tons of templates, however Twig allows you to easily inherit templates and also override the templates where you can inject content into the block easily. Don't worry if you don't understand the concept, the following parts will explain with an example of how to easily inherit layouts and templates.
      Layout
      <!DOCTYPE html> <html lang="en"> <head> {{include("layout/elements/header.twig")}} </head> <body> <div class="container-fluid" id="minimal"> <header id="pageIntro"> <div class="bio_panel"> <div class="bio_section col-md-6"> <h1>Okeowo Aderemi</h1> <h2>{{ page.body }}</h2> </div> </div> <div class="clearfix"></div> </header> <section id="page-body"> <div class="container"> <div id="intro" class="col-md-7 col-lg-7"> <h1>About me</h1> <h2> {{ page.summary }} </h2> </div> {block name="content"}{/block} <a style="font-size:1.799783em; font-style:italic;color:#d29c23" href="{{pages.get('/notes').url }}">Read more articles</a> </div> <div class="clearfix"></div> </div> </section> </div> <footer> <div class="header-container headroom headroom--not-top headroom--pinned" id="header-container"> {{include("layout/elements/footer.twig")}} </div> </footer> </body> </html> This is basically a layout where we specify blocks and include other templates for the page, don't panic if you don't understand what is going on, I will simply break down the weird part as follows:
      Include
      This basically is similar to native PHP 'include', as it's name suggests it simply includes the templates and injects the content into the layout , nothing out of the ordinary here if you are already familiar with php's include function.
      {{ output }}
      This simply evaluates the expression and prints the value, this  evaluate expressions, functions that return contents , in my own short words it's basically the same as <?= output ?> except for the fact that it's cleaner to read.
      {% expression %}
      unlike the previous this executes statements such as for loops and other Twig statements.
      {% for characters in attack_on_titans %} <h1> {{characters}} </h1> {% endfor %} This  executes a for loop and within the for loop, it creates a context to which variables in that context can be referenced and evaluated, unlike dealing with the opening and closing PHP tags, Twig simply blends in with markup and makes it really quick to read. 
      I will simply post the contents of both the header and footer so you can see the content of what is included in the layout
      header.php
      <meta charset="utf-8"/> <meta content="IE=edge" http-equiv="X-UA-Compatible"/> <meta content="width=device-width, initial-scale=1" name="viewport"/> <title> {{ page.title }} </title> <link href=" {{config.urls.templates }}assets/css/bootstrap.min.css" rel="stylesheet"/> <link href="{{config.urls.templates }}assets/css/main.min.css" rel="stylesheet"/> <link rel='stylesheet' type='text/css' href='{{config.urls.FieldtypeComments}}comments.css' /> <link rel="stylesheet" href="{{config.urls.siteModules}}InputfieldCKEditor/plugins/codesnippet/lib/highlight/styles/vs.css"> <script type="text/javascript" src="{{config.urls.siteModules}}InputfieldCKEditor/plugins/codesnippet/lib/highlight/highlight.pack.js"></script> <script src="{{config.urls.templates }}assets/js/vendors/jquery-1.11.3.min.js"> </script> <script src="{{config.urls.templates }}assets/js/vendors/bootstrap.min.js"> </script> <script src="{{config.urls.FieldtypeComments}}comments.js"></script> <link rel="stylesheet" type='text/css' href="{{config.urls.templates}}js/jquery.fancybox.min.css"> <script src="{{config.urls.templates}}js/jquery.fancybox.min.js"></script> {block name="javascriptcodes"}{/block} footer.php
      <nav class="site-nav pull-right"> <div class="trigger"> <a class="page-link" href="{{pages.get('/about').url}}"> <span>{</span> About <span>}</span> </a> <a class="page-link" href="{{pages.get('/notes').url}}"> <span>{</span> Journals <span>}</span> </a> <a class="page-link" target="_blank" href="https://ng.linkedin.com/in/okeowo-aderemi-82b75730"> <span>{</span> Linkedin <span>}</span> </a> <a class="twitter page-link" target="_blank" href="https://twitter.com/qtguru"> <span>{</span> Twitter <span>}</span> </a> </div> </nav> There's nothing special here, other than twig simply injecting these fragments into the main layout , the next part is the most interesting and important concept and benefit that Twig has to offer
      {% block content %}{% endblock %}
      This tag simply creates a placeholder in which the content would be provided by the template inheriting this layout, in lay terms it simply means child templates will provide content for that block, the 'content' simply uses the name 'content' to refer to that specific block, so assuming we were to inherit this template it would simply look like this.
      Inheriting Template Layout
      {% extends 'layout/blog.twig' %} {% block content %} <div class="container blog-container"> <section class="blog"> <header class="blog-header"> <h1> {{page.title}} </h1> <h5 class="blog_date"> {{page.published|date("F d, Y")}} </h5> <br> </br> </header> <div class="blog_content"> <hr class="small" /> {{page.body}} <hr class="small" /> </div> </section> </div> {% endblock %} {% block nav %} <div class="col-md-4 col-xs-4 col-sm-4 prev-nav"> <a href="{{page.prev.url}}"> ← Prev </a> </div> <div class="col-md-4 col-xs-4 col-sm-4 home-nav"> <a href="{{homepage.url}}"> Home </a> </div> <div class="col-md-4 col-xs-4 col-sm-4 next-nav"> <a href="{{page.next.url}}"> Next → </a> </div> {% endblock %} In this snippet you can easily notice how each blocks previously created in the header and layout are simply referenced by their names, by now you will notice that twig doesn't care how you arrange the order of each block, all Twig does is to get the contents for each blocks in the child templates and inject them in the layout theme, this allows flexible templating and also extending other layouts with ease.
      Twig in Processwire
      Thanks to @Wanze we have a Twig Module for Processwire and it's currently what i use to build PW solutions to clients
      https://modules.processwire.com/modules/template-engine-twig/
      The Modules makes it easy to not only use Twig in PW but also specify folders to which it reads the twig templates, and also injects Processwire objects into it, which is why i can easily make reference to the Pages object, another useful feature in this module is that you can use your existing template files to serve as the data provider which will supply the data to be used for twig template.
      take for example, assuming I wanted the homepage to display the top six blog posts on it, TemplateEngineTwig will simply load the home.php ( Depending on what you set as the template), it is also important that your twig file bears the same name as your template name e.g home.php will render into home.twig here is an example to further explain my point.
      home.php
      <?php //Get the Top 6 Blog Posts $found=$pages->find("limit=6,include=hidden,template=blog-post,sort=-blog_date"); $view->set("posts",$found);  
      The $view variable is the TemplateEngine which in this case would be Twig, the set method simply creates a variables posts which holds the data of the blog posts, the method allows our template 'blog.twig' to simply reference the 'posts' variable in Twig Context. Here is the content of the 'blog.twig' template
      blog.tpl
      {% extends 'layout/blog.twig' %} {% block content %} <div class="block_articles col-md-5 col-lg-5"> {% for post in posts %} <div class="article_listing"> <span class="article_date"> {{post.published}}</span> <h2 class="article_title"> <a href="{{post.url}}">{{post.title}}</a> </h2> </div> {% endfor %} {% endblock %} So home.php sets the data to be used in home.tpl once Twig processes the templates and generates the output, twig takes the output from the block and injects it in the appriopriate block in the layout, this makes Processwire templating more flexible and fun to work with. 
      The major advantage this has; is that you can easily inherit layouts and provide contents for them with ease, without the need of running into confusions when handling complex layout issues,an example could be providing an administrator dashboard for users on the template side without allowing users into the Processwire back-end. You can also come up with several layouts and reusable templates.
       
      Feel free to ask questions and any concerns  in this approach or any errors I might have made or overlooked.
      Thanks
       
       
       
    • By pycode
      Hello PW, 
      discovered few days ago this awesome cms and now want to start a project on it, but need some help. I'm coming from the drupal side, which I kinda like, but it is not usable for smaller projects like I need now. I like it's way to build to content from the ground up, but it feels heavy, don't know why. PW feels really light and want to give it a try.
      Long story short, development it is a hobby for me, so everything I do is self-learned throw try & error, no programming skills yet. I want to learn JS now, and for that, want to translate a website to my native Romanian language so I can learn myself and others in the future. The site I'm talking about is www.learn.javascript.ru
      I want to build a similar structured site (please see the attached image):

      Home / Projects / About will be basic page template based, no problem with them.
      mysite.com/javascript/
      Starting Learn JavaScript will be a basic page template as well, I can make it statit, as it will contain some info and links to the Sections of the JS theory pages.
      mysite.com/javascript/section-name/
      By accessing a section page, I want to see again some description text and links of the attached unit pages to this section, so when I open any section it shows me all the attached unit pages to it. On the sidebar, I need to render links to all the sections, just that.
      Next is unit pages like mysite.com/javascript/section-name/unit-name/
      Here goes the units text, main content in other words, like a blog post. The key point is to have a dropdown and select the section page for it. For sidebar, I want to render the list with links for every headline from the unit page. Will do it by using Jumplinks Hanna Code, I believe it will do the job perfectly.
      Who can give me a hand with the templates?
      first /javascript/ page I can do as a basic page.
      next /javascript/section-name/ don't know. what fields should it contain for linking units?
      and last /javascript/section-name/unit-name/ again, what field needs to be used for linking? Page refference I believe?
      How I write it to templates?
      Would be gratefull for your help guys,
      Thank you
       
    • By alxndre
      Easiest, fastest, most reliable framework.
      Considering my workload this past weeks, I'm considering on switching.
      It supports a wide range of applications: