Templates pages

In this article

Templates are central to Banana's offer.
They will be completed with the necessary documentation for their use.

The documentation will also become important for their presentation and their SEO.

Example:

See also Specific rules for Universal templates.

Template resources

For each template there is:

  • A Template page in drupal  (www)
  • A Template ID that is automatically assigned in drupal.
    • Create a template page, save it to have a template ID.
    • Eventually set the flag not published.
  • A template file .
  • A template tutorial (with opening balances, transactions and budget) used to show how to use and for creating images.
  • Images files and other resources.
  • An export file in html for a preview, that is automatically created.

GitHub Repository

The template file is hosted on GitHub, together with a copy of the file with useful content for images.

  • Directory structure is dependent on the specific repository.
  • If there are many languages use the language code (en, it, de, zh-hans)
  • The template file
    • Should be hosted on the repository for the nation, universal or other (Financial planning)
    • The name is composed by the template Id and a description (lower case, and underscore)
      10489_company_double entry.ac2
  • Template Directory
    A sub-directory of where the template file is hosted.
    • The directory name should be the Template ID.
    • It contains:
      • Tutorial file.
        A copy of the template file with opening balances, transactions, and other necessary content to create images.
      • The images for presentation. See format on the drupal description.
      • Images file for the documentation - file name should be lowercase and without spaces.

Template file

Is the file that is downloaded and used within the File New.

  • The file name should possibly be lowercase and without spaces.
  • The name should begins with the template ID number "10000_double_entry.ac2"

Content

  • File Properties.
    • Simple name.
      Do not enter the account year in the description.
    • Date should be the date of the current year.
      We should provide a way to automatically update the date, but with the option to not change it.
  • Accounts Table.
    There should be no opening amounts
  • Transactions Table.
    • Basically there should be no transactions.
    • If for some reasons you want to keep transactions, write in the first two lines.
      "Example's rows. You can remove with the command "Menu->Edit->Delete rows."
  • Budget Table.
    • If the template is focused on creating a forecast (like a Family Budget or Cash plan), the rows in the budget tables are very helpful. The user need only to enter the amounts, rent, salary, expenses and the budget is easily completed.
      • Keep the budget rows.
      • Empty all amounts in the budget rows.
  • VAT Table.
    • Should include the full updated VAT Table.
  • Exchange Rate Table.
    • Should include some currencies and exchange rate.

Tutorial file

The one used for doing the images. 

  • It is stored in the template directory
  • Create content so that images are informative and nice.
    Also consider be able to make Charts that look nice.
  • Opening balance.
  • Transactions Table.
    • Create transaction for some months for at least one Revenues and one Costs (so that we have a nice Chart).
  • Budget Table.
    • Create transactions for each month for Revenues and one Costs (so that we have a nice Chart).

Tutorial files only

  • If the file is used as a tutorial, there is not template file, only create the example file and enter only the url of the template.  When creating a XML file for Banana the file will be automatically included in the Template field.
  • Budget formula explanations (the most important part are the budget transactions examples).
  • JavaScript Tutorial 1

Drupal template page

Titles

  • Main title.
    • It should be interesting for SEO and be distinguishable from other templates that are similar.
    • Separate description from type with "|"
      "Cash Flow Forecast for freelance and small companies | Cash Manager (Free)"
  • Book title.
    Short max two words.
  • Title for File new dialog
    It should not contain Country, Accounting type; this information is already available.

Summary

  • Page Summary
    Should explain what you can do with the template and its benefits.
    Be mindful that the first line is what will be displayed in Google search.
    Follows the concept of metatag explained here.
  • Summary for File New.
    If you need a different summary for internal use. Keep it short.

Url

  • File URL
    The url of the template file.
    If there is only the example file enter here the url of the example file.
  • Tutorial File URL
    When present insert the url of the tutorial file.

Presentation Image

The image is hosted on GitHub

  • When showing a program, take the whole program and possible add some Charts.
  • Please do not use any other dimensions. Make sure to curate the table and registrations as beautiful as possible and make sure that all text on the table is visible and readable.
  • When possible show either graphs or a print preview of a report.

Video

Add the video only if is different, to the default application video.

  • Url for the video
    (tipically the link to youtube video.
  • Description

Body

  • The purpose of the solution.
    • How it serves our users and
    • What it is intended for.
  • Description on how to use it.
  • Explanations. Include links to the documentation page.
  • Images:
    • First image should display the whole program.
    • When possible make a view with charts to that it looks more appealing.
    • Images should have an Alternative text value, so the image will rank better on google image search.
  • References to other documentation.

How to create Banana Accounting images

  • Always using the command Ctrl+3
  • Image dimensions 1280px * 800px.
  • Select the type of image (“Capture all” or “Capture table and info window”...)
  • Save the image in the Github folder

How to edit images created with Banana Accounting

  • Create the Banana image with the Ctrl+3 function
  • Save the image on Github
  • Open the Greeshot program
  • Click on “Open image from file” and select the image in the folder where it was saved
  • Select “Open in image editor”
  • Edit the image with Greenshot tools
  • Save the image again with the same name and in the same folder

Rendering of the drupal page

  • Summary is also used as a metatag.
  • When available display the link to:
    • How to start with a template
    • Download Template file
    • Template file preview
    • Download Tutorial file. (with example data)

Template access in Banana Accounting

Portal for download of the template list

A view export the template list with all the information.

  • In the XML file for Banana
    • If there are Template and Tutorial return both.
      In the new version of Banana we will let user also open the Tutorial file when available.
    • If there is only the Tutorial file, use the file also to fill the Template file .
      In this case we have the same file twice, but we can be compatible with Banana 8 and 9 version.

Dialog File new

Easy to search

  • By nation, language, type, and category.
  • By Template ID.

Help on template:

  • It should be possible to get help by going directly to the page of the template that has been used for creating the file.
    In order to do so, we have to save the following:
    • Indication of the origin of the template, for the moment banana.ch template store.
    • Template id.
  • Choose to open the template file or the tutorial file if both are available.
    Users should also be able to open the relative tutorial file.

Share this article: Twitter | Facebook | LinkedIn | Email