User talk

Tom Hutchison: Difference between revisions

From Joomla! Documentation

Tom Hutchison (talk | contribs)
m replies to two threads
 
(49 intermediate revisions by 15 users not shown)
Line 1: Line 1:
<div class="messagebox" style="float:right; width:280px;"><center>'''Archived Talk Pages'''</center><splist/></div>__TOC__
<div class="large-12 columns panel">
<div class="large-9 columns">
===Leave a Message===
If you have any questions or problems on Joomla! Documentation, just use the add a topic, leave me a message and don't forget to sign it with 4 tildes(<nowiki>~~~~</nowiki>).</div>
<div class="large-3 columns panel radius"><center>'''Archived Talk Pages'''</center><small><splist/></small></div></div>
{{-}}__TOC__


== Barnstar and a few bits and bobs ==
== Merging "Setting up workstation..." discussion ==


Thankyou very much for the barnstar!!
Hello, I dunno if you will get it automatically, but here some thoughts on your merge proposal: http://docs.joomla.org/Talk:Setting_up_your_workstation_for_Joomla!_development#Merge_Warning
One thing I've noticed whilst doing the help screens is that when you press the help buttons in Joomla 2.5 is that there are [edit] links next to each section. But these links take you to a blank page - so is there any way we can drop the edit buttons?


Also I noticed one of the help buttons earlier today took you to the Joomla 1.6 help page instead of the 2.5 (when pressed in Joomla 2.5). It was one of the menu items  - but typically as I'm writing this I've completely forgotten which - not sure how easy it will be to check up on this!
== Component development for 3.2 is somewhat unfinished ==


Thanks again,
Hi,
George
I'm trying to follow the tutorial for developing a component for Joomla 3.2
But somehow it is not very friendly to a person like me, new to Joomla development.
What can I do, in order to make this tutorial more "newbie"-friendly ?
[[User:Cwurtz|Cwurtz]] ([[User talk:Cwurtz|talk]]) 22:29, 13 December 2013 (CST)
::Hi Cwurtz, thanks for asking! J3.2 MVC is really incomplete, partly because the J2.5 version still valid, and partly because J2.5 still needs to be copied over into the J3.2 namespace and then improved. You are free to help as you would like and it would be greatly appreciated! How can I help get you started? [[User:Tom Hutchison|Tom Hutchison]] ([[User talk:Tom Hutchison|talk]]) 10:28, 14 December 2013 (CST)


:No problem! You deserved one, you've done a lot of work on the 2.5 Help Screens and other articles over the past week!  
== It's Joomla! (!) ==


:The link itself is nulled out by the proxy. The [edit] link used to be regex'd out but since the MW 1.16 to 1.19 update, something must have changed in 1.19. We are looking at that. Another thought was to use <nowiki>__NOSECTIONEDIT__</nowiki> to remove the [edit] links from the page. Makes it harder to update them, but once the Help screen is done it should not be necessary to update them. At least not a regular task, just a bug fix or small tweak here and there.
Hi Tom,<br />
I was wondering if we should enforce the use of the exclamation mark, which is part of the trade mark IMHO, in titles and throughout the text?


:Was the link in the pop-up window's address bar something like ...help.joomla.org/proxy/index.php?option=com_help&keyref=Help16  or just the page contained information of a 1.6 Help Screen? The first would be a bug, second is a possibility. The next version released Help screens are dumped into the new namespace and content of page links are changed to reflect the new namespace for the new release. I know there are a couple of 1.7 Help screens using pure transclusion to show the 1.6, something like:
I noticed that in your recent addition [[Joomla_Credits_and_Thanks]] (starting from the title ;) )
:'''<nowiki>{{:Help16:The_name_of the_1.6_HelpScreen}}</nowiki>''' is the only content so it may have just been put into the 2.5 screen.


:Let me know if you can remember if it was content or address and I'll see if I can track it down.
--[[User:Elkuku|Elkuku]] ([[User talk:Elkuku|talk]]) 10:15, 17 May 2014 (CDT)
::--Thanks again! [[User:Hutchy68|Tom Hutchison]] ([[User talk:Hutchy68|talk]]) 20:42, 9 February 2013 (CST)


:::Found another link issue whilst trying to find that Joomla 1.6 link:
:Usually yes, but... we have to watch breaking the ability to link from the forum to doc pages. Using mod_security on the family of our sites with some strange rules which can and does cause issues. We have used titles like Installing Joomla! and the link was broken on the forum, then we had to change it. Latest quirk I heard was driver on the forum being wrapped as [driver] even in JDatabaseDriver to JDatabase[Driver]. ?'s are an issue too. Docs has a toned down mod_security, we couldn't even use 'source' in code tags at one point last fall.
:::External URL page - Page takes you to: http://help.joomla.org/proxy/index.php?option=com_help&keyref=Help25:Menus_Menu_Item_Manager_Edit instead of the external URL page http://docs.joomla.org/Help25:Menus_Menu_Item_External_Url
:::Cheers for the information!
:::--[[User:Wilsonge|Wilsonge]] ([[User talk:Wilsonge|talk]]) 02:38, 10 February 2013 (CST)


::Thanks George! I knew this problem existed in Joomla! 3, but didn't have a chance to check 2.5. Assumed it did. It actually is everything under, System Links in Menu selection. The other two Help Screen pages are 'red links' still, but they will have the same issue. I filed a tracker here: [http://code.joomla.org/gf/project/joomla/tracker/?action=TrackerItemEdit&tracker_id=11410&tracker_item_id=30091 Tracker 30091].
:Joomla! vs Joomla in text. This is tricky, I have been told Joomla! as the first use in a page, then Joomla for every following use on the same page. Still not sure myself because OSM pages use !'s on the entire page. If 1st use is the rule, we need to document it on the use of Joomla! and Joomla! Logos page on OSM. I'll investigate the use some more and at least get it somewhere in writing for all.


:: I also had to filed another tracker for [http://code.joomla.org/gf/project/joomla/tracker/?action=TrackerItemEdit&tracker_id=11410&tracker_item_id=30090 Module Manager - Edit - (Blank page)]:
:I went ahead and changed the title adding a ! and left the other as a redirect to the ! page if there is a problem using the Joomla! page as a url on the forum. They can always link without the ! and it will redirect to the correct usage one.
::*Select Site -> Control Panel (Landing page when first logging on to administration)
::*Select Help -> Joomla Help Click link in left sidebar: 'Module Manager - Edit'
::*View a blank page, ref to source on docs.joomla.org which does not exist.


::This is actually causing a 404 error, need to address this right away as it is a "Top 10" requested Help Screen page for all Help Screens. Some of the issues in 3.0 are 2.5 used a modal window and now 3.0 has an actual page. These might not be corrected till the release of 2.5.10. I'll look into it.
:Thanks for adding to JetBrains on the Credits and Thanks page. I just set the page up last night and had not gotten to what JetBrains does for the project. We were discussing all this on leadership mail list, etc... and I had not let everyone know I created the page. Doing that now.
:::---Thanks again! [[User:Hutchy68|Tom Hutchison]] ([[User talk:Hutchy68|talk]]) 09:30, 10 February 2013 (CST)


:::Nice one with the trackers. The link was an address by the way for the 1.6. But I went through all the menu items I edited his w/e and I can't see it. So I'm not sure where it was now. Will have to go on a hunt!
:Thanks!! [[User:Tom Hutchison|Tom Hutchison]] ([[User talk:Tom Hutchison|talk]]) 12:42, 17 May 2014 (CDT)
:::Cheers! --[[User:Wilsonge|Wilsonge]] ([[User talk:Wilsonge|talk]]) 02:47, 11 February 2013 (CST)


::Thanks for confirming the one, I pushed them to a couple of bug squad members to address. In the meantime, I will fix the one I can with a redirect and new page. The 404 bothers me a lot! You might have noticed, starting work on JDOC projects too. A bit earlier than I was going to, hope there is interest. --- Take care [[User:Hutchy68|Tom Hutchison]] ([[User talk:Hutchy68|talk]]) 10:30, 12 February 2013 (CST)
== How to add an article ==


== Module and Template Development ==
Hi Tom,


Hi, I saw your post on my discussion page regarding the tutorials. It has always been the intention to move these articles out into the global namespace. The primary reason the tutorials currently live in my user namespace is three-fold:
I am quite new to Joomla, and certainly to this Documentation wiki, so I am not sure if this is the proper place for asking.


1. I didn't want the code in the articles to diverge from the code in the repository as I have seen happen numerous times in other tutorials. People have a habit of updating tutorial pages and not the source code packages which ultimately create a lot of confusion.
For my project I need to develop a small component and it was quite an experience to search for the information that I needed. Eventually I got started and wrote down my findings in a tutorial. This may be useful for this Documentation pages but I don't know how to add an article. At present the tutorial is on github https://github.com/Sky-High/Joomla3-Edit-and-Export/wiki .
2. I wanted to test them out for a while to rule out bugs. (I consider this phase to be completed)
3. Since the release of 2.5 I have been meaning to find the time to remove a bit of deprecated code to make it fully "2.5" compliant.


As I have not had time to perform the last step yet, they have remained in my user namespace. I also started on a basic module and template tutorial that I have not had the time to finish.
Could you help with a suggestion on how to proceed?


That being said, I would be happy to help maintain the tutorial code for developers as far as my time allows and this may also help me jump-start my own effort in this area. I have previously suggested adding a "joomla-tutorials" project under the "joomla" organization in GitHub but regardless of how this is deployed I think it would be a very healthy approach to the management of tutorial code.
Thanks


[[User:Rvsjoen|Rvsjoen]] ([[User talk:Rvsjoen|talk]]) 14:31, 11 February 2013 (CST)
- Eric


:That's great Rvsjoen! I didn't even know you had a MVC tutorial in your user pages. I'm trying to pull together the docs, improve them and get the devs involved again. If we move them, I will mark them as incomplete so they can be checked against code on pages vs. code in zips. Something I agree with, they need to be the same and maintained as such. This is why there is interest in moving it all to GitHub. We should maintain a version specific structure. 2.5 is easy and 1.6 and 1.7 should be dropped. 3.0 is already out, but I would like to see it as 3.x because eventually it will become a LTS version 3.5. Git will also allow to see the progression of code change too. I am still working to pull this all together. Thanks so much for your interest!
[[User:Skyhigh|Skyhigh]] ([[User talk:Skyhigh|talk]]) 09:35, 16 March 2016 (CDT)
::--- [[User:Hutchy68|Tom Hutchison]] ([[User talk:Hutchy68|talk]]) 16:15, 11 February 2013 (CST)


::The MVC tutorial in my user pages is a complete update/rewrite of the original 1.7 tutorial mostly created by Christophe, it has at some point also been reviewed by several people in the JBS. It is currently 100% up to date with the code in the zip packages as far as I know.  
== Migrating Joomla ==
https://docs.joomla.org/Joomla_2.5_to_3.x_Step_by_Step_Migration
'''At J3.1 the Joomla update component needs to be updated (Extensions >>> Manage >>> update)''' before it is used to update J3.1 to J3.6.2
--Topazgb 20:11, 12 October 2016 (CDT)


::Also I noticed that a joomla/jdoc-examples repository has been created for this purpose on GitHub. I do not know if these two "projects" are related but if they are I would encourage whoever responsible to put a folder structure in place for storing more than just tutorials. For example something like...
== Contributing to Joomla developer documentation ==


::* Tutorials
Hi Tom,
::** Component
::** Module
::** Plugin
::*** System plugin
::*** User plugin
::*** Etc..
::** Library
::** Template
::* Extensions
::** Example extension 1
::** Example extension 2
::** Etc...
::* Code snippets
::** Code snippet 1
::** Code snippet 2
::** Etc..


:: I submitted a pull request on GitHub which implements this idea, so i'll just wait and see whether it's pulled or not. [https://github.com/joomla/jdoc-examples/pull/1 Pull Request #1]
I'm interested in contributing to Joomla documentation for developers, and I was wondering if there was any group of people looking specifically at that area, and if so, how do they meet / communicate together, are there any plans for improvement or aspirations as to what they'd really like to have as a set of documentation.


In particular I was thinking about producing a series of videos to accompany the Developing an MVC Component tutorial pages (eg explaining a bit more about why the code is written that way). If I did that, is it possible to upload videos onto the wiki, or is it better to host them on youtube and link to the videos from the wiki?


Thanks,
Robbie. 
[[User:Robbiej|Robbiej]] ([[User talk:Robbiej|talk]]) 10:28, 17 April 2017 (CDT)


::::--- [[User:Rvsjoen|Rvsjoen]] ([[User talk:Rvsjoen|talk]]) 06:44, 12 February 2013 (CST)
Placed by [[User:JoomlaWikiBot|JoomlaWikiBot]] ([[User talk:JoomlaWikiBot|talk]]) 10:46, 2 July 2017 (CDT)


:: Rune, I saw your pull request. I'm working on getting you write access to this folder right now. I would like to see the devs control it. Currently there is a MVC for 2.5. Another user put in work last Aug/Sept to bring the 1.5 up to 2.5. Case in point on why there should be a specific wiki project by devs for dev Tutorials. I don't know if you have seen it, but it starts here, [[Developing_a_Model-View-Controller_Component/2.5]]. Here is the project site [[JDOC:Developer Tutorial Project|Developer Tutorial Project]], I'm trying to get more devs involved with this. It really is to any devs's benefit as it will help maintain a correct tutorial, allow new devs to succeed as a Joomla dev and improve the Docs wiki.
== Using the parameter {{{1}}} ==
:: --Thanks again [[User:Hutchy68|Tom Hutchison]] ([[User talk:Hutchy68|talk]]) 10:30, 12 February 2013 (CST)
 
 
Hi Tom,
I am helping with the German translation of J4 relevant pages for some time now.
 
However, I am still a novice when it comes to Mediawiki markups and the technical details of Joomla.
I try to learn from already existing documentation pages by example.
 
This is quite tedious, because either I don't have the right search terms or the necessary information is scattered all over the site.
 
I have been struggling with one problem for quite a while:
It concerns, for example, the page '''https://docs.joomla.org/Help4.x:Articles''' and the chunks connected with it.
For sure, other pages will have the same problem as soon as they use parameters like '''{{{1}}}''' or '''{{{1|item}}}''' or anything similar.
 
Maybe I don't understand the logic behind the parameter. In any case, I cannot find any values assigned to the variable.
I do see a list of existing chunks, but I am missing a list that allows me to see on which pages a certain chunk is embedded, as it exists in the Media Viewer.
 
===For example:===
The difficulty is that the universal English term "item" is ambiguous when translated into German and, depending on the context, should be translated with several terms in order to remain accurate. In addition, there are 3 gender variants for the English article "the" in German ("der", "die", "das"). The noun is also spelled differently, depending on the case (see the table on https://en.wikipedia.org/wiki/Article_(grammar)#Tables).  
 
I would like to demonstrate what I have just said using the [https://docs.joomla.org/Help4.x:Articles above page]:
 
Let's look at the section "Toolbar" in the source document:
 
<pre>
<translate>
==Toolbar== <!--T:51-->
</translate>
{{safesubst:Chunk4x:Help_screen_toolbar_top_descriptor/<translate>
<!--T:113-->
en</translate>}}
{{safesubst:Chunk4x:Help_screen_toolbar_icon_New/<translate><!--T:55-->
en</translate>|<translate><!--T:56-->
article</translate>}}
</pre>
 
And now the source document of Chunk4x:Help_screen_toolbar_icon_New:
 
<pre>
<noinclude><languages /></noinclude>
<translate>
<!--T:1-->
*'''New'''. Opens the editing screen to create a new {{{1|item}}}.</translate>
</pre>
 
====The translation of the chunk here will be:====
*'''+Neu:''' Öffnet das Bearbeitungs-Formular, um <span style="background-color:yellow;">ein neues Item</span> zu erstellen.
 
As the neutral article "das" is associated with "Item", the adjective "neu" (new) must be written as "neues".
 
'''Let's go back to the main page:'''
There, "<!--T:56-->article" specifies the term "item".
In the German Joomla documentation, it is common to translate the term "article" as "Beitrag".
The problem now is that this term is assigned the masculine article "der". This means that the adjective "neu" is declined as "neuer" (see https://en.wikipedia.org/wiki/German_articles and https://en.wikipedia.org/wiki/German_adjectives).
 
=====So, using correct grammar, the line on the main page should look like:=====
 
*'''+Neu:''' Öffnet das Bearbeitungs-Formular, um <span style="background-color:yellow;">einen neuen Beitrag</span> zu erstellen.
 
=====However, the line is displayed incorrectly:=====
 
*'''+Neu:''' Öffnet das Bearbeitungs-Formular, um <span style="background-color:yellow;">ein neues Beitrag</span> zu erstellen.
 
It is a poor translation outcome.
 
I am afraid, I don't have the technical background to find any solution or workaround.
 
'''Do you have any ideas?'''
 
Dieter Ziller/[[User:Max123kl|Max123kl]] ([[User talk:Max123kl|talk]]) 07:44, 22 May 2021 (CDT)

Latest revision as of 12:55, 22 May 2021

Leave a Message

If you have any questions or problems on Joomla! Documentation, just use the add a topic, leave me a message and don't forget to sign it with 4 tildes(~~~~).
Archived Talk Pages
<splist/>

Merging "Setting up workstation..." discussion

Hello, I dunno if you will get it automatically, but here some thoughts on your merge proposal: http://docs.joomla.org/Talk:Setting_up_your_workstation_for_Joomla!_development#Merge_Warning

Component development for 3.2 is somewhat unfinished

Hi, I'm trying to follow the tutorial for developing a component for Joomla 3.2 But somehow it is not very friendly to a person like me, new to Joomla development. What can I do, in order to make this tutorial more "newbie"-friendly ? Cwurtz (talk) 22:29, 13 December 2013 (CST)

Hi Cwurtz, thanks for asking! J3.2 MVC is really incomplete, partly because the J2.5 version still valid, and partly because J2.5 still needs to be copied over into the J3.2 namespace and then improved. You are free to help as you would like and it would be greatly appreciated! How can I help get you started? Tom Hutchison (talk) 10:28, 14 December 2013 (CST)

It's Joomla! (!)

Hi Tom,
I was wondering if we should enforce the use of the exclamation mark, which is part of the trade mark IMHO, in titles and throughout the text?

I noticed that in your recent addition Joomla_Credits_and_Thanks (starting from the title ;) )

--Elkuku (talk) 10:15, 17 May 2014 (CDT)

Usually yes, but... we have to watch breaking the ability to link from the forum to doc pages. Using mod_security on the family of our sites with some strange rules which can and does cause issues. We have used titles like Installing Joomla! and the link was broken on the forum, then we had to change it. Latest quirk I heard was driver on the forum being wrapped as [driver] even in JDatabaseDriver to JDatabase[Driver]. ?'s are an issue too. Docs has a toned down mod_security, we couldn't even use 'source' in code tags at one point last fall.
Joomla! vs Joomla in text. This is tricky, I have been told Joomla! as the first use in a page, then Joomla for every following use on the same page. Still not sure myself because OSM pages use !'s on the entire page. If 1st use is the rule, we need to document it on the use of Joomla! and Joomla! Logos page on OSM. I'll investigate the use some more and at least get it somewhere in writing for all.
I went ahead and changed the title adding a ! and left the other as a redirect to the ! page if there is a problem using the Joomla! page as a url on the forum. They can always link without the ! and it will redirect to the correct usage one.
Thanks for adding to JetBrains on the Credits and Thanks page. I just set the page up last night and had not gotten to what JetBrains does for the project. We were discussing all this on leadership mail list, etc... and I had not let everyone know I created the page. Doing that now.
Thanks!! Tom Hutchison (talk) 12:42, 17 May 2014 (CDT)

How to add an article

Hi Tom,

I am quite new to Joomla, and certainly to this Documentation wiki, so I am not sure if this is the proper place for asking.

For my project I need to develop a small component and it was quite an experience to search for the information that I needed. Eventually I got started and wrote down my findings in a tutorial. This may be useful for this Documentation pages but I don't know how to add an article. At present the tutorial is on github https://github.com/Sky-High/Joomla3-Edit-and-Export/wiki .

Could you help with a suggestion on how to proceed?

Thanks

- Eric

Skyhigh (talk) 09:35, 16 March 2016 (CDT)

Migrating Joomla

https://docs.joomla.org/Joomla_2.5_to_3.x_Step_by_Step_Migration At J3.1 the Joomla update component needs to be updated (Extensions >>> Manage >>> update) before it is used to update J3.1 to J3.6.2 --Topazgb 20:11, 12 October 2016 (CDT)

Contributing to Joomla developer documentation

Hi Tom,

I'm interested in contributing to Joomla documentation for developers, and I was wondering if there was any group of people looking specifically at that area, and if so, how do they meet / communicate together, are there any plans for improvement or aspirations as to what they'd really like to have as a set of documentation.

In particular I was thinking about producing a series of videos to accompany the Developing an MVC Component tutorial pages (eg explaining a bit more about why the code is written that way). If I did that, is it possible to upload videos onto the wiki, or is it better to host them on youtube and link to the videos from the wiki?

Thanks, Robbie. Robbiej (talk) 10:28, 17 April 2017 (CDT)

Placed by JoomlaWikiBot (talk) 10:46, 2 July 2017 (CDT)

Using the parameter {{{1}}}

Hi Tom, I am helping with the German translation of J4 relevant pages for some time now.

However, I am still a novice when it comes to Mediawiki markups and the technical details of Joomla. I try to learn from already existing documentation pages by example.

This is quite tedious, because either I don't have the right search terms or the necessary information is scattered all over the site.

I have been struggling with one problem for quite a while: It concerns, for example, the page https://docs.joomla.org/Help4.x:Articles and the chunks connected with it. For sure, other pages will have the same problem as soon as they use parameters like {{{1}}} or item or anything similar.

Maybe I don't understand the logic behind the parameter. In any case, I cannot find any values assigned to the variable. I do see a list of existing chunks, but I am missing a list that allows me to see on which pages a certain chunk is embedded, as it exists in the Media Viewer.

For example:

The difficulty is that the universal English term "item" is ambiguous when translated into German and, depending on the context, should be translated with several terms in order to remain accurate. In addition, there are 3 gender variants for the English article "the" in German ("der", "die", "das"). The noun is also spelled differently, depending on the case (see the table on https://en.wikipedia.org/wiki/Article_(grammar)#Tables).

I would like to demonstrate what I have just said using the above page:

Let's look at the section "Toolbar" in the source document:

  ==Toolbar==
 
 {{safesubst:Chunk4x:Help_screen_toolbar_top_descriptor/  en}}
 {{safesubst:Chunk4x:Help_screen_toolbar_icon_New/ en| article}}

And now the source document of Chunk4x:Help_screen_toolbar_icon_New:

 <noinclude><languages /></noinclude>
   *'''New'''. Opens the editing screen to create a new {{{1|item}}}.

The translation of the chunk here will be:

  • +Neu: Öffnet das Bearbeitungs-Formular, um ein neues Item zu erstellen.

As the neutral article "das" is associated with "Item", the adjective "neu" (new) must be written as "neues".

Let's go back to the main page: There, "article" specifies the term "item". In the German Joomla documentation, it is common to translate the term "article" as "Beitrag". The problem now is that this term is assigned the masculine article "der". This means that the adjective "neu" is declined as "neuer" (see https://en.wikipedia.org/wiki/German_articles and https://en.wikipedia.org/wiki/German_adjectives).

So, using correct grammar, the line on the main page should look like:
  • +Neu: Öffnet das Bearbeitungs-Formular, um einen neuen Beitrag zu erstellen.
However, the line is displayed incorrectly:
  • +Neu: Öffnet das Bearbeitungs-Formular, um ein neues Beitrag zu erstellen.

It is a poor translation outcome.

I am afraid, I don't have the technical background to find any solution or workaround.

Do you have any ideas?

Dieter Ziller/Max123kl (talk) 07:44, 22 May 2021 (CDT)