joomla/Component-Builder
joomla
/
Component-Builder
38
20
Fork 11
Code Issues 53 Pull Requests Projects 3 Releases Wiki Activity

Updated 046 General overview of how community snippets work (markdown)

Amigo 2019-07-09 13:25:09 +02:00
parent aa055d3aeb
commit 741c4221f6
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
046-General-overview-of-how-community-snippets-work.md

@ -63,5 +63,7 @@ But if you like me and you want to know exactly what's going on you could read t
We're excited about this. We hope that this will really faster a lot of participation and that it will improve JCB constantly. [00:12:52](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h12m52s) Snippets are used in these fork key areas Custom Admin Views, Site Views, Templates, Layouts. These areas are what the customer sees, the one that uses the component. We want to be always sure to have the latest and most stable Snippets ready and available for everyone using JCB. [00:13:16](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h13m16s) Once you have imported the new snippet you will be able to see it at the end of your Snippets. Navbar is now the latest one we've imported. If you open the snippet, you will see that contributed details are already in place and so these contributed details will be updated as you add new Snippets.
### When Details Not In Place - Say Dynamic Field
????
If for some reason these details are not [00:13:41](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h13m41s) in place it will say dynamic field. Let me show you there. Just create a new one. It says dynamic field. When you have created your snippet, I'm just going to do a simple test here to illustrate this. [00:14:03](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h14m03s) If you click save, it will first search the JCB Snippet Repository to see if there is a snippet with this kind of a relationship between the Name, the Type and the Library. If it doesn't exist it will go to your Global area like explained [00:14:31](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h14m31s) and they will get your details and dynamically added in to the snippet. It found my details and put it in there. That is how this details get set When you create a snippet a new one It will fall back to your details [00:14:51](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h14m51s) If that snippets Name, Type and library relationship doesn't already exist in the JCB Community. Now if for some reason it does exist it will take the initial contributors details and add that in there. That's how it works at this stage. Maybe there is better ways but for now this is how we will start at least And I'm sure it will evolve and change as we go along until we are able to actually [00:15:22](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h15m22s) satisfy all and everyone's needs I think that's enough of an overview Of how everything works So you've Seen how to use the Snippets in your components You've seen how to Start initial steps of sharing a snippet You simply select them like I showed you Obviously Only when you have improved on it or whether you've created new ones will you ever wanna do that [00:15:48](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h15m48s) And then you click on Share snippet and gives you a package And Then on that it Let me just show you again On that it has a Few tutorials like Tutorials I'm forking the JCB Snippets And Tutorial making a pull request These two tutorials would be quite key [00:16:11](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h16m11s) For you to understand what would be this next steps And getting your Snippets Into the JCB community Well thank you for watching And Yeah Until next time
If for some reason these details are not [00:13:41](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h13m41s) in place it will say dynamic field. Let me show you there. Just create a new one. It says dynamic field. When you have created your snippet, I'm just going to do a simple test to illustrate this. [00:14:03](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h14m03s) If you click save, it will first search the JCB Snippet Repository to see if there is a snippet with this kind of a relationship between the Name, the Type and the Library. If it doesn't exist it will go to your Global area like explained [00:14:31](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h14m31s) and they will get your details and dynamically added in to the snippet. It found my details and put it in there. That is how this details get set when you create a snippet, a new one, it will fall back to your details [00:14:51](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h14m51s) if that Snippets Name, Type and Library relationship doesn't already exist in the JCB community. Now if for some reason it does exist it will take the initial contributors details and add that in there. That's how it works at this stage.
Maybe there is better ways but for now this is how we will start. I'm sure it will evolve and change as we go along until we are able to [00:15:22](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h15m22s) satisfy all and everyone's needs. I think that's enough of an overview of how everything works. You've seen how to use the Snippets in your components. You've seen how to start initial steps of sharing a snippet. You simply select them like I showed you. Only when you have improved on it or whether you've created new ones will you ever want to do that. [00:15:48](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h15m48s) Then you click on Share Snippet and it gives you a package. It has a few tutorials like tutorials on forking JCB Snippets. And tutorial making a pull request. These two tutorials would be quite key [00:16:11](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h16m11s) for you to understand what would be this next steps and getting your Snippets into the JCB community.