Blogg-X 2.11 Manual

 

Blogg-X is a cross platform (Windows XP SP2, Apple OSX 10.4.3 and Linux) content management utility for web sites based on the Joomla! Open Source Content Management System (CMS).

Blogg-X is written in Java, which provides the ability to work with a variety of systems with Java runtimes available and installed.

Blogg-X eliminates the need to log into your Joomla! site using your internet browser.  Once Blogg-X is configured your settings are remembered and posts, including images, can quickly be posted, modified and deleted without using the Joomla! interface.

 

Index

Posting your first article. 3

Main Window.. 6

Button Explanations. 9

Drop Down Menu Explanations. 10

Add Site Wizard Windows. 12

Account Settings Window.. 14

Options Window.. 16

Initial Blogg-X Setup. 23

Installation. 30

Windows. 30

Apple. 30

Linux (to be added) 30

Administrator. 30

Requirements. 30

Blogg-X Features. 31

So how does Blogg-X work?. 32

Licensing. 32

Additional Software used within Blogg-X.. 32

Troubleshooting. 34


Posting your first article

So you have your site settings configured (if not click here) and you’re ready to easily post content using Blogg-X.  Follow these simple steps to begin:

1.  Select the site you wish to post to.  See item 1 in the image above.

2.  Enter the “Title” for the article/post.  See item 2 in the image above.

3.  Select the “Section” that contains the category you want.  See item 3 in the image above.

4.  Select the “Category” to put article/post into.  See item 4 in the image above.

5.  Enter the “Intro Text” that you wish to show on the site.  From here you have all kinds of options for creating the text.  See the example below.

6.  Once you have the “Intro Text” section complete you can OPTIONALLY enter text into the “Main Text” area by clicking on the tab.  Again you can apply all the text formatting options in this area as well.


7.  So you have the post ready for the website.  Click on the “Publish Action” dropdown as illustrated in the image below:

Here you have three options.

1.      “Unpublished” – this will store the article/post on the website, but won’t be displayed.

2.      “Published” – this will store the article/post on the website and it will be displayed in the specified section and category.

3.      “Published Frontpage" – this will store the article/post on the website and it will be displayed on the frontpage.

8.  Once you select a “Publish Action” the article/post will be sent to the website and after successful completion you will receive a window and then Blogg-X will return to its original state ready to start another article/post.

9.  You have now successfully used Blogg-X to manage content on your Joomla! site!!


Main Window

Items highlighted in GREEN are OPTIONAL.

Items highlighted in RED are required for posting.

“File” Menu

“Edit” Menu

“View” Menu

“Font” Menu

“Format” Menu

“HTML” Menu

“Tools” Menu

“Help” Menu

Button Explanations

Load Post

 

Underline

Save Post

 

Strikethrough

Undo

 

Font Color

Redo

 

Text Font (incomplete)

Cut

 

Align Left

Copy

 

Align Center

Paste

 

Align Right

Paste Special

 

Align Justified

Clear all Fields

 

Insert Image

Remove all Formatting

 

Insert Hyperlink

Help

 

Toggle HTML/WYSIWYG Editor

Bold

 

Bullets (incomplete)

Italic

 

Numbered Bullets (incomplete)


Drop Down Menu Explanations

Dropdown 1:  List of all the configured sites within Blogg-X.  Select the site that you wish to work with via this dropdown.  On Blogg-X launch, if you have configured a default site in the “Account Settings” window, it will automatically select the default site.  Note:  Will be empty if no sites are configured.

Dropdown 2:  “Load/Delete Posts…”  Provides options for the number of previous posts (those already on the server) to load into Blogg-X.  Also provides the ability to move posts into the trash.  Moving a post into the trash from Blogg-X works the same as Joomla!.  The article/post isn’t deleted just removed from the site and does not show when selecting the number of posts to load.  To view the articles/posts that are in the trash select “Show Trash” from the dropdown.  When viewing the titles of the articles in the trash you can select an individual article to load into Blogg-X for republishing, you will also have the option to permanently delete the post via the “Delete Permanently” button.  Note:  Once a post has been permanently deleted via this menu it cannot be recovered.

Dropdown 3:  “Publish Action…”  Provides the following options:

·         “Unpublished”

o       Submits the article/post to the server without publishing it.

·         “Published”

o       Submits the article/post to the server and publishes it into the selected section and category.

·         “Published Frontpage”

o       Submits the article/post to the server and publishes it into the selected section and category and makes it displayed on the site frontpage.

Note:  After loading a post via the “Load/Delete Posts…” button the title of dropdown #3 will change to “Update Action…” but will still have the same options and actions as the “Publish Action…” button.


Additional Publishing Settings (located at bottom of Main Window above the status bar)  All these are completely OPTIONAL and not required.


Add Site Wizard Windows

Note:  The FTP settings are OPTIONAL.

Each step in the “Add Site Wizard” will explain the settings required in each field.  If you don’t plan on using the image support functions then the FTP settings don’t need to be entered.  Remember that once the wizard is closed that the settings can still be changed in the “Account Settings” window.


Account Settings Window

Most of these settings will already be filled in after completing the “Add Site Wizard”.  Changes can be made to the settings here, just click the “Apply Changes” button to save the changes.

“Media Directories” Explanation

Buttons


Options Window

“General Options” tab

“Connection Options” tab

“Paste Special Options” tab

·         “Remove All Formatting (line breaks are preserved)

·         “Remove All “<” Characters”

·         “Remove All “>” Characters”

·         “Replace Double Spacing After “.” (replace with single space)”

·         “Remove All Single <br> tags”

Following are some before and after examples using the “Paste Special” options individually.  Remember that all, some or none of the options need to be enabled.


Before “Remove All Formatting”

After “Remove All Formatting”


Before “Remove All “<” Characters”

After “Remove All “<” Characters”


Before “Remove All “>” Characters”

After “Remove All “>” Characters”


Before “Replace Double Spacing After “.” (replace with single space)”

After “Replace Double Spacing After “.” (replace with single space)”


Before “Remove All Single <br> tags”

After “Remove All Single <br> tags”


Initial Blogg-X Setup

1.  After installing and launching Blogg-X you will see the window below:


2.  You now need to setup your site for use with Blogg-X.  This can be started with the “Tools” “Account Settings” window.


3.  Once in the “Account Settings” window it will not have any sites configured, so click on the “Add Site…” button to start the configuration.

4.  The first step in the add site wizard is setting up the address for your site.

Notice that the “http://” is automatically used by Blogg-X and you don’t need to enter it.  For example if your Joomla! site is at “http://www.site.com/joomla” then in Blogg-X in the “Site Address” field you would enter “www.site.com/joomla”.


5.  Next you need to enter your Joomla! username and password.  The Joomla! userlevel must be an “Author”, “Publisher”, “Administrator” or “Super Administrator”.

Clicking the “Verify” button will check the entered username and password with your Joomla! site.  Once the user is verified you will receive the following window:


6.  The next step (“Add Site Wizard – Step 3 of 3”) is for setting up the FTP settings.  The FTP settings are completely optional and only needed to support the use of uploading images in the posts from Blogg-X.  These settings can be left completely blank.

The “Base Path” field for most sites will be either “/” or “public_html/”.  If you are unsure of the right setting it can be determined by running your FTP program with the username and password and making note of the location that the login defaults to.  That path is what would be entered in the “Base Path” field.


7.  After clicking the “Finish” button from the “Add Site Wizard – Step 3 of 3” you will return to the “Account Settings” window.  You will see your account listing and clicking on it will display all the settings and will look similar to the picture below.


8.  If you have entered the FTP settings you will also want to set up the “Media Directories” section as well.  This section tells Blogg-X where your images are stored on the FTP server.  To start click the “Edit…” button as shown below.  This section is completely OPTIONAL.

9.  Once in the “Edit…” window it will look like the image below.

In this example the “images” and “images/stories” folder created by a Joomla! installation have been entered.  If you have other folders where you have images stored on the server enter them here.  For example if you have a folder titled “photos” on your server in the root directory you would enter “photos” into the window above.  This will allow you to browse the images stored on the server and reuse them in your posts. When you are finished click the “OK” button.

10.  Once you have the site settings configured and any optional items configured you are done setting up your site.  If you want to add settings for another site just repeat the process.  Clicking “OK” will return you to the main Blogg-X window.

Installation

Before installing Blogg-X be sure that you have the appropriate Java JRE installed for your system.  Blogg-X checks this during install and won’t proceed if it can’t find the Java installation. 

Windows

1.      Install the Blogg-X application on your system.  The installer is a standard installer and does not perform anything out of the ordinary.

Apple

1.      Please ensure the Java JRE 5.0 the first Java environment.  This can be changed in the "/System/Applications/Utilities/Java/J2SE 5.0" folder buy running the "Java Preferences" application and dragging "J2SE 5.0" in the "Java Application Runtime Settings" box so it's on top of "J2SE 1.4.2".

2.      Install the Blogg-X application on your system.  The installer is a standard installer and does not perform anything out of the ordinary.

Linux (to be added)

            1.

            2.        

            3.

Administrator

1.      Install the mambot on your Joomla! server.  The Blogg-X mambot is installed the same as all other mambots in Joomla! via the administration interface.  The mambot is located in the Blogg-X installation directory on your computer.  It is also available as a separate download at http://www.iobinary.com.

2.      Ensure the Blogg-X mambot is published in the Joomla! administration interface.

3.      Check to make sure the “blogg-x_2_0” folder in the mambots directory has permissions of 755, if not change it.

4.      Check to make sure all files in the “blogg-x_2_0” folder has permissions of 644, if not change them.

Requirements


Blogg-X Features

So how does Blogg-X work?

Blogg-X communicates with your site via Apache XML-RPC.  The Blogg-X application works as a client on your system while the included Blogg-X mambot, once installed on your Joomla! site, acts as the server.  Blogg-X has limited interaction with the Joomla! application itself, mostly for configuration settings.  Both the Blogg-X application and the mambot are making changes in the database that Joomla! creates and runs from.  At first this may sound dangerous but this is the same way that creating content from within Joomla! works.  Both Blogg-X and Joomla! are just providing a user interface to perform database tasks.

Licensing

Both Blogg-X Free and Blogg-X Pro are released under the GNU GPL.  Information on the license agreement can be found in the Blogg-X installation directory or via the web at:

http://www.gnu.org/copyleft/gpl.html

As required by the GPL all source code will be provided upon request.  To request the source please email support@iobinary.com.

Additional Software used within Blogg-X


Troubleshooting

Error: “URL incorrect or mambot not loaded”

Possible Reason 1:  You may have the URL for your site incorrectly entered in the “Account Settings” window.  Be sure that it is in the following format:  www.iobinary.com and NOT http://www.iobinary.com.  Blogg-X already knows that the prefix to your site will be http:// so entering it again will cause problems.

Possible Reason 2:  The mambot is not correctly loaded on your Joomla! site.  Verify via the Joomla! administration interface that the Blogg-X mambot states the current latest version.  Both the Blogg-X application and the mambot will carry the same version numbers to eliminate confusion.  For example if you are using Blogg-X 2.0 then the server should state that the mambot is version 2.0. 

Possible Reason 3:  You may be behind a proxy server on your local computer and this is preventing Blogg-X from communicating with the mambot.  If you are behind a proxy server you will have to determine the settings and enter those into Blogg-X via the “Tools”, “Options” window.  For more information see the section titled “Options Window” in this document.

Error:  While in the intro text or main text fields sometimes the highlighting doesn’t work correctly or the last line seems to disappear

Reason:  This is a known bug in Java 1.5.0.5 and above when dealing with Synth user interfaces, which Blogg-X is using.  Bug reports have been filed with SUN by myself and the developer for the GUI that Blogg-X is using.  I will post notification on the website when the issue has been resolved.

Error:  Blogg-X fails to load at all after installation, just sits at the splash screen indefinitely

Possible Reason 1:  This will most likely occur to users that had a previous version of Blogg-X installed (0.85 beta or earlier) and installed this version to the same directory.  With all the changes implemented in Blogg-X 2.0 the “settings.xml” file that Blogg-X is using is incompatible with the older versions.  When doing an uninstall of a previous version of Blogg-X it will keep the “settings.xml” in case Blogg-X is installed again, saving you the need of re-accomplishing the settings.  To fix this problem, uninstall Blogg-X using the uninstaller then manually remove the Blogg-X folder from the “Program Files” directory or the location that you installed it.  Reinstall Blogg-X and the error should be gone.

Error:  Blogg-X shows a bunch of “*******************” in the password field on the “Account Settings” window

Reason:  This is not an error but a correct action by Blogg-X.  The password as you entered it into Blogg-X is stored as an MD5 hash and not as plain text.  This is a small security mechanism for Blogg-X.  The “*” characters that you are seeing are representing each character in the MD5 hash of the password.