It is currently Thu Dec 14, 2017 6:32 am

All times are UTC + 1 hour [ DST ]




Post new topic Reply to topic  [ 1 post ] 
Author Message
 Post subject: Documentation suggestion
PostPosted: Sun Apr 20, 2014 7:07 pm 
Offline

Joined: Sun Apr 20, 2014 6:06 pm
Posts: 1
Hi
An excellent and effective plugin. :) Because I thought your plugin was very neat and useful, I wrote an article for my users which I have attached as a pdf to see if it would also be useful to yourselves. EDIT I could not attach it as you do not allow pdfs. :( How should I send this pdf? It has several examples.

Just a couple of thoughts.

Firstly I think using ACBR as the default column break is not very helpful, especially to new users. It is not easy to spot in long text steams. So I suggest something like //// which is very readily seen, and easier to type. Obviously you need to support ACBR as a default but supporting both is not difficult.

The second item is a bit picky. Using brake_code gives the wrong message to an English speaker. It should be break_code. Brake means braking as in slowing down a car, break means splitting into parts. Again not difficult to support both spellings.

Your code carefully allows either AC or ac but it might be simpler if all the 'parameters' went through strtoupper or strtolower before being compared as that gives even more flexibility.

Another tiny point AC_SPACING_LABEL="Columns Spacing" would be better as AC_SPACING_LABEL="Column Spacing"

Also PLG_CONTENT_ADMIRORCOLUMNIZER_XML_DESCRIPTION reads better in English as the following.
Code:
PLG_CONTENT_ADMIRORCOLUMNIZER_XML_DESCRIPTION="<img src='../media/plg_admirorcolumnizer/media/logo.jpg' /><br />Put text content you want to be in columns inside the trigger code, for example: <b>{AC}<i>Your Content</i>{/AC}</b>.<p>&nbsp;</p>Place ACBR inside your text wherre you want to break the text into the next column.<p>&nbsp;</p>Find out more about Admiror Columnizer usage at <a target='_blank' href='http://www.admiror-design-studio.com/en/joomla-extensions/admiror-columnizer/manuals'>Admiror Columnizer Manual webpage</a>.<br/>Support for Admiror Columnizer is available at: <a target='_blank' href='http://www.vasiljevski.com/forum/index.php'>Admiror Joomla! Community</a>. <p>&nbsp;</p><a target='_blank' style='background-image:url(../media/plg_admirorcolumnizer/media/support-projects.jpg); text-decoration: none; display:block; width:250px; height:120px;' href='http://www.admiror-design-studio.com/en/joomla-extensions/support-our-projects'> </a><p>&nbsp;</p>This plugin uses the great javascript library Hyphenation.js. For more information about this library visit <a href='http://code.google.com/p/hyphenator/' target='_blank' >Hyphenation.js</a> webpage.<p>&nbsp;</p>"


I hope these suggestions are helpful, as your code is helping me!

Colin


Top
 Profile  
 
 Post subject: Documentation suggestion
PostPosted: Sun Apr 20, 2014 7:07 pm 
Top  
Display posts from previous:  Sort by  
Post new topic Reply to topic  [ 1 post ] 

 


All times are UTC + 1 hour [ DST ]


Who is online

Users browsing this forum: No registered users and 1 guest


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Search for:
Jump to:  
cron

This is the official Admiror Joomla! Community Forum. You are welcome to join the Admiror Joomla! Community. All Admiror Joomla! Extensions Users, Joomla! Developers, PHP or mySQL Developers are welcome to support & contribute to Admiror Joomla! Projects.

Joomla! is a free and open source content management system (CMS) for publishing content on the World Wide Web and intranets. With a vibrant volunteer community, user-friendly features and plenty of power, Joomla is perfect for your website!

Joomla! is written in PHP, uses object-oriented programming (OOP) techniques and software patterns, stores data in a MySQL database, and includes features such as page caching, RSS feeds, printable versions of pages, news flashes, blogs, polls, search, and support for language internationalization.

Joomla! is the property of Open Source Matters, Inc. All rights reserved. Read more about Joomla! at http://www.joomla.org/.


Protected by Anti-Spam ACP Powered by phpBB® Forum Software © phpBB Group