How can you help the User Documentation Project?

Joomla! Documentation Workgroup

Moderators: Chris Davenport, Hutchy68

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1382
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: How can you help the User Documentation Project?

Postby Chris Davenport » Wed Jul 22, 2009 7:24 am

Just add the following at the end of your article:

Code: Select all

[[Category:Tips and tricks]][[Category:Tips and tricks 1.5]]

Sounds like a really useful article. :)

Thanks,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

ampedpupil
Joomla! Apprentice
Joomla! Apprentice
Posts: 5
Joined: Tue Dec 02, 2008 7:41 am

Re: How can you help the User Documentation Project?

Postby ampedpupil » Thu May 27, 2010 3:49 am

I noticed in the docs.joomla.org tutorials that the "Editing Remove the Text Larger / Smaller AAA icon" page contains a partial and, to me, incorrect solution for removing these tools. The posted solution removes only the tool .png images and leaves the links and their functions in place. This can easily be tested by applying that solution and running the cursor over where the "AAA" images used to be.

The proper way to remove these tools is to open templates/ja_purity/ja_templatetools.php and comment out the following code at around line 72:

Code: Select all

   /* if (in_array(JA_TOOL_FONT, $_array_tools)){//show font tools
      ?>
      <ul class="ja-usertools-font">
         <li><img style="cursor: pointer;" title="<?php echo JText::_('Increase font size');?>" src="<?php echo $this->templateurl();?>/images/user-increase.<?php echo $imgext;?>" alt="<?php echo JText::_('Increase font size');?>" id="ja-tool-increase" onclick="switchFontSize('<?php echo $this->template."_".JA_TOOL_FONT;?>','inc'); return false;" /></li>
        <li><img style="cursor: pointer;" title="<?php echo JText::_('Default font size');?>" src="<?php echo $this->templateurl();?>/images/user-reset.<?php echo $imgext;?>" alt="<?php echo JText::_('Default font size');?>" id="ja-tool-reset" onclick="switchFontSize('<?php echo $this->template."_".JA_TOOL_FONT;?>',<?php echo $this->_tpl->params->get(JA_TOOL_FONT);?>); return false;" /></li>
        <li><img style="cursor: pointer;" title="<?php echo JText::_('Decrease font size');?>" src="<?php echo $this->templateurl();?>/images/user-decrease.<?php echo $imgext;?>" alt="<?php echo JText::_('Decrease font size');?>" id="ja-tool-decrease" onclick="switchFontSize('<?php echo $this->template."_".JA_TOOL_FONT;?>','dec'); return false;" /></li>
      </ul>
      <script type="text/javascript">var CurrentFontSize=parseInt('<?php echo $this->getParam(JA_TOOL_FONT);?>');</script>
      <?php
      } */


This will remove the images AND the corresponding links to the font resizing functions which may be clicked upon by an unwary user when they see their cursor turn into a pointer over this area.

I didnt feel comfortable editing the docs page as it looks to be part of a series in the [[Tutorial:Customising_the_JA_Purity_template|tutorial]]. I was also unable to find a place to comment on it so I decided to post it here in the hopes that it eventually reaches the right area or the right person.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1382
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: How can you help the User Documentation Project?

Postby Chris Davenport » Thu May 27, 2010 6:26 pm

Hi ampedpupil,

Please feel free to correct the documentation. At the very least, can you please post these comments on the discussion page. You get to it by clicking on the "discussion" tab at the top of the page.

Thanks,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

timtheg
Joomla! Apprentice
Joomla! Apprentice
Posts: 9
Joined: Mon Oct 25, 2010 5:38 am

Re: How can you help the User Documentation Project?

Postby timtheg » Thu Nov 04, 2010 5:24 am

Is this thread still active? I'd like to contribute to the documentation project, but what is the proper venue? This one seems to be unmanned.

Thanks!
Tim

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1382
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: How can you help the User Documentation Project?

Postby Chris Davenport » Thu Mar 17, 2011 8:16 pm

To contribute to the wiki documentation you just need to register on the wiki and you will automatically be granted write access.

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/


Return to “Documentation - Feedback/Information/Suggestions”

Who is online

Users browsing this forum: No registered users and 5 guests