joomla/Component-Builder
39
25
Fork 11
Code Issues 76 Pull Requests Projects 4 Wiki Activity

Updated 040 Adding Helper Structures to any JCB component (markdown)

Amigo
2019-08-02 09:57:58 +02:00
parent 0551ba0550
commit dc90c05ea9
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
040-Adding-Helper-Structures-to-any-JCB-component.md

@ -36,12 +36,19 @@ This is usually what will be used when a component gets shipped . Since this wil
* ### Type - Text
You could say text for [00:07:20](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m20s) example, and you could say "This is the help you need" and whatever. Save and close. If we go to Looks, we'll see automatically there is a new button called Help. If we click on it, it opens that Help. [00:07:47](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m47s) You can go back to if you click on New then that Help menu won't show anymore. But you can close out, and you can then go back to the Help Documents, create another one. Again select or you could target a specific group, or you can target all groups. Again Admin area you can also target the Site area, and be able to link it to any of the front end areas. We can say now we don't want to [00:08:32](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h08m32s) target the list(Looks), but the edit area(Look) which is singular. Again we can say give it a title. This time let me link it to an URL. Save and close. Let's go to Looks area, add New, and now we see that area also has a Help button. If we click on it, it opens that URL [00:09:13](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m13s) in a pop-up, and as you see I just selected a video. That is how you can link to other external sources to be giving the Help to the specific page in the instructions that is necessary.
[00:07:20](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m20s)
For example: 'Text' can be used, and "This is the help you need" can be typed in or whatever. Save and close. If 'Looks' is opened, a new button called 'Help' is shown. If it is used it opens that 'Help'. [00:07:47](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h07m47s) Go back and click 'New' then that 'Help menu' will not be displayed anymore. You can close , and go back to the 'Help Documents' and create another one. Again a specific group may be targeted , or all groups can be targeted. Again at Admin area. The Site area can also be targeted, and it is possible to link it to any of the front end areas. [00:08:32](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h08m32s) It may be decided not to target the list(Looks), but the edit area(Look) which is singular. Again a title may be given to it. In this instance link it to an URL. Save and close. Then in the 'Looks' area, add New, and now it can be seen that area also has a Help button. When the help button is used, it opens that URL in a pop-up, and as may be seen a video is selected .[00:09:13](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m13s) That is how to link to other external sources to give instructions that is necessary(Help) to a specific page.
### System Name
* Remember to Compile Before Install
* NB.Remember to Compile Before Install
Having set up a few Help Menus for the Component you can go back to Component Builder and to the Admin View [00:09:46](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m46s) Area, and let's say you have a Help Document linked to Component Demo, you want to ship it with the information that you've created as Help inside of the Component. What I would do is, I would open this Admin View, and I'll give it a system name of demo. I'll go to MySQL(add MySQL), [00:10:31](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h10m31s) say yes, I wanted to link it. I'll select MySQL source - Table. I would go to the Demo Table, select a Table. You see demo_help_document click on that, and I'll just remove some of the values that I know is not necessary.(See video) Created modified and version can stay. Save and close. I can save this or save as copy. If I have another component, I'll copy Help Document(demo) and link it to that components database. The only thing to remember when you've done this [00:11:36](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m36s) Is it is you must first compile the component before you uninstall the local component. First come here(Compiler) and compile that(demo) component.
[00:09:36](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h09m36s)
Having set up a few Help Menus for the Component you can go back to Component Builder and to the Admin View Area. If for instance a Help Document is linked to Component Demo, and you want to ship it with the information that you have created as 'Help' inside of the Component. What needs to be done, is to open this Admin View, and give it a system name of 'Demo'. Then go to MySQL(add MySQL), and indicate by 'Yes' that it should be linked.<<<
[00:10:31](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h10m31s) I'll select MySQL source - Table. I would go to the Demo Table, select a Table. You see demo_help_document click on that, and I'll just remove some of the values that I know is not necessary.(See video) Created modified and version can stay. Save and close. I can save this or save as copy. If I have another component, I'll copy Help Document(demo) and link it to that components database. The only thing to remember when you've done this [00:11:36](https://www.youtube.com/watch?v=nw9YPu9emws&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h11m36s) Is it is you must first compile the component before you uninstall the local component. First come here(Compiler) and compile that(demo) component.
### Insert Tables - Linking Table To Component