Recherche avancée

Sur d’autres sites (4996)

• How to create a custom theme in Piwik – Introducing the Piwik Platform

  23 août 2014, par Thomas Steur — Development

  This is the start of a new blog series where we introduce the capabilities of the Piwik platform. You’ll learn how to write custom plugins & themes, how to use our HTTP APIs and more.

  We have been greatly simplifying our APIs over the last year focusing primarily on one design principle :

  The complexity of our API should never exceed the complexity of your use case.

  In other words, if you have a simple use for our API, we want it to be simple for you to accomplish it. If you have a complex, big, hairy, change-the-world idea, then maybe we can’t make it simple for you to accomplish it, but we want it to be possible.

  Over the next weeks and months you will learn what exactly we mean by this and how we accomplished it.

  FYI, don’t worry if you’re currently using our APIs, we keep them backwards compatible and we announce breaking changes in our platform changelog.

  Getting started

  In this series of posts, we assume that you have already set up your development environment. If not, visit the Piwik Developer Zone where you’ll find the tutorial Setting up Piwik.

  To summarize the things you have to do to get setup :

  • Install Piwik (for instance via git).
  • Activate the developer mode : ./console development:enable --full.
  • And if you want, generate some test data : ./console visitorgenerator:generate-visits --idsite=1 --limit-fake-visits=600. This can take a while and requires the VisitorGenerator plugin from the Marketplace.

  Let’s start creating our own theme

  We start by using the Piwik Console to create a blank theme :

  ./console generate:theme

  The command will ask you to enter a name, description and version number for your theme. I will simply use “CustomTheme” as the name of the theme. There should now be a folder plugins/CustomTheme which contains some files to get you started easily.

  Before we modify our theme, we have to activate it by visiting the Settings => Themes admin page in our Piwik installation, or alternatively by running the command ./console core:plugin activate YourCustomTheme. If the theme is not activated, we won’t see any changes.

  Theme Contents

  The most important files in our theme are plugins/CustomTheme/stylesheets/theme.less, plugins/CustomTheme/stylesheets/_colors.less and plugins/CustomTheme/stylesheets/_variables.less :

  • theme.less is the file that will be included when your theme is activated. In this file you would include other stylesheet files and overwrite CSS styles.
  • _colors.less contains many less variables allowing you to easily change the colors Piwik uses.
  • _variables.less contains currently only one variable to change the font family. More variables will be added in the future. Note : This is a new feature and the file will be only there in case you have installed Piwik using Git or at least Piwik 2.6.0.

  Changing the font family

  To change the font family simply overwrite the variable @theme-fontFamily-base: Verdana, sans-serif; in _variables.less. That’s it.

  Changing colors

  To change a color, uncomment the less variables of the colors you want to change in _colors.less. I will shortly explain some of them. Usually changing only these colors will be enough to adjust Piwik’s look to your corporate design or to create a look that pleases you :

  @theme-color-brand:                    #d4291f; // The Piwik red which is for instance used in the menu, it also defines the color of buttons, the little arrows and more
  
  @theme-color-brand-contrast:           #ffffff; // Contrast color to the Piwik red. Usually you need to change it only in case you define a light brand color. For instance to change the text color of buttons
  
  @theme-color-link:                     #1e93d1; // The link color which is usually a light blue
  
  
  
  @theme-color-widget-title-text:        #0d0d0d; // The text and background color of the header of a widget (Dashboard)
  
  @theme-color-widget-title-background:  #f2f2f2;
  
  
  
  @theme-color-menu-contrast-text:       #666666; // The text color of a menu item in the reporting sub menu and the admin menu
  
  @theme-color-menu-contrast-textActive: #0d0d0d; // The text color of an active menu item
  
  @theme-color-menu-contrast-background: #f2f2f2; // The background color of a menu item
  
  
  
  @graph-colors-data-series[1-8]:        #000000; // The different colors used in graphs

  Making the change visible

  To make a color or font change actually visible when you reload a page in Piwik you will have to delete the compiled CSS file after each change like this :

  rm tmp/assets/asset_manager_global_css.css

  Publishing your Theme on the Marketplace

  In case you want to share your theme with other Piwik users you can do this by pushing your theme to GitHub and creating a tag. Easy as that. Read more about how to distribute a theme.

  Advanced features

  Isn’t it easy to create a custom theme ? All we had to do is to change some less variables. We never even created a file ! Of course, based on our API design principle, you can accomplish more if you want. For instance, you can change icons, CSS stylesheets, templates and more.

  For further customising your Piwik, you can even change the logo and favicon in the Settings => General settings page.

  Would you like to know more about theming ? Go to our Theme guide in the Piwik Developer Zone.

  If you have any feedback regarding our APIs or our guides in the Developer Zone feel free to send it to us.

  PS : see also this related FAQ : How do I White Label Piwik ?

• How to create a custom theme in Piwik – Introducing the Piwik Platform

  23 août 2014, par Thomas Steur — Development

  This is the start of a new blog series where we introduce the capabilities of the Piwik platform. You’ll learn how to write custom plugins & themes, how to use our HTTP APIs and more.

  We have been greatly simplifying our APIs over the last year focusing primarily on one design principle :

  The complexity of our API should never exceed the complexity of your use case.

  In other words, if you have a simple use for our API, we want it to be simple for you to accomplish it. If you have a complex, big, hairy, change-the-world idea, then maybe we can’t make it simple for you to accomplish it, but we want it to be possible.

  Over the next weeks and months you will learn what exactly we mean by this and how we accomplished it.

  FYI, don’t worry if you’re currently using our APIs, we keep them backwards compatible and we announce breaking changes in our platform changelog.

  Getting started

  In this series of posts, we assume that you have already set up your development environment. If not, visit the Piwik Developer Zone where you’ll find the tutorial Setting up Piwik.

  To summarize the things you have to do to get setup :

  • Install Piwik (for instance via git).
  • Activate the developer mode : ./console development:enable --full.
  • And if you want, generate some test data : ./console visitorgenerator:generate-visits --idsite=1 --limit-fake-visits=600. This can take a while and requires the VisitorGenerator plugin from the Marketplace.

  Let’s start creating our own theme

  We start by using the Piwik Console to create a blank theme :

  ./console generate:theme

  The command will ask you to enter a name, description and version number for your theme. I will simply use “CustomTheme” as the name of the theme. There should now be a folder plugins/CustomTheme which contains some files to get you started easily.

  Before we modify our theme, we have to activate it by visiting the Settings => Themes admin page in our Piwik installation, or alternatively by running the command ./console core:plugin activate YourCustomTheme. If the theme is not activated, we won’t see any changes.

  Theme Contents

  The most important files in our theme are plugins/CustomTheme/stylesheets/theme.less, plugins/CustomTheme/stylesheets/_colors.less and plugins/CustomTheme/stylesheets/_variables.less :

  • theme.less is the file that will be included when your theme is activated. In this file you would include other stylesheet files and overwrite CSS styles.
  • _colors.less contains many less variables allowing you to easily change the colors Piwik uses.
  • _variables.less contains currently only one variable to change the font family. More variables will be added in the future. Note : This is a new feature and the file will be only there in case you have installed Piwik using Git or at least Piwik 2.6.0.

  Changing the font family

  To change the font family simply overwrite the variable @theme-fontFamily-base: Verdana, sans-serif; in _variables.less. That’s it.

  Changing colors

  To change a color, uncomment the less variables of the colors you want to change in _colors.less. I will shortly explain some of them. Usually changing only these colors will be enough to adjust Piwik’s look to your corporate design or to create a look that pleases you :

  @theme-color-brand:                    #d4291f; // The Piwik red which is for instance used in the menu, it also defines the color of buttons, the little arrows and more
  
  @theme-color-brand-contrast:           #ffffff; // Contrast color to the Piwik red. Usually you need to change it only in case you define a light brand color. For instance to change the text color of buttons
  
  @theme-color-link:                     #1e93d1; // The link color which is usually a light blue
  
  
  
  @theme-color-widget-title-text:        #0d0d0d; // The text and background color of the header of a widget (Dashboard)
  
  @theme-color-widget-title-background:  #f2f2f2;
  
  
  
  @theme-color-menu-contrast-text:       #666666; // The text color of a menu item in the reporting sub menu and the admin menu
  
  @theme-color-menu-contrast-textActive: #0d0d0d; // The text color of an active menu item
  
  @theme-color-menu-contrast-background: #f2f2f2; // The background color of a menu item
  
  
  
  @graph-colors-data-series[1-8]:        #000000; // The different colors used in graphs

  Making the change visible

  To make a color or font change actually visible when you reload a page in Piwik you will have to delete the compiled CSS file after each change like this :

  rm tmp/assets/asset_manager_global_css.css

  Publishing your Theme on the Marketplace

  In case you want to share your theme with other Piwik users you can do this by pushing your theme to GitHub and creating a tag. Easy as that. Read more about how to distribute a theme.

  Advanced features

  Isn’t it easy to create a custom theme ? All we had to do is to change some less variables. We never even created a file ! Of course, based on our API design principle, you can accomplish more if you want. For instance, you can change icons, CSS stylesheets, templates and more.

  For further customising your Piwik, you can even change the logo and favicon in the Settings => General settings page.

  Would you like to know more about theming ? Go to our Theme guide in the Piwik Developer Zone.

  If you have any feedback regarding our APIs or our guides in the Developer Zone feel free to send it to us.

  PS : see also this related FAQ : How do I White Label Piwik ?

• End of Piwik Mobile 1 – Focus is on Piwik Mobile 2

  2 septembre 2014, par Piwik Core Team — Community, Piwik Mobile Releases

  More than four years after its initial release, we will remove Piwik Mobile 1 from the Apple App Store and Google Play Store in one week. During that time the app was downloaded more than 60.000 times with an average rating of 4.6 and over 2000 ratings. Thank you to our community of users for all of this !

  Why we must focus on Piwik Mobile 2

  Unfortunately we do not have the resources to maintain Piwik Mobile 1 to be compatible with the latest iOS and Android updates (namely iOS 8 and Android L). The last update of Piwik Mobile 1 was over one year ago and the underlying framework, which we are using to develop the app, is nearly two years old. Making the code compatible with the current version of the underlying framework to support the latest platform versions would take us many weeks. As a little background : From the beginning Piwik Mobile 1 has been a free app and was developed by a single person Thomas in his spare time who is now focussing on Piwik Mobile 2.

  Can I still get it ?

  We are announcing this today so you get a chance to install the app via the Apple App Store and Google Play Store while it is still available.

  If you are one of the 87% of our Piwik Mobile 1 users who are already using Android 4+ or iOS 7+ then you can install Piwik Mobile 2 (make sure you upgrade your Piwik platform to 1.12 or 2.x recommended).

  What happens after the app is removed ?

  If you have already installed the app it won’t be removed from your device and you will still be able to use it. Android users can still download Piwik Mobile 1 but we cannot guarantee it will work on all devices. Lastly the code our free software is available on GitHub and you can build it from the source if you have to.

  The future of Piwik Mobile

  Piwik Mobile version 2.1 is currently in beta testing phase. This new version includes several useful new features such as support for Segmentation. If you use Android, give it a try !