03 Documentation

    Browsersupport

    The Theme supports Chrome, Firefox, Safari, Edge. It works for Internet Explorer 11 in a limited way.


    Required plugins


    Make products searchable by SKU

    After you setup the wordpress theme and installed all required plugins follow these steps:

    1. Head to "Plugins" in WP-Admin and look for the "Relevanssi" plugin
    2. Click on "Settings"
    3. Navigate to the tab "Indexing"
    4. Head to the settings section "Custom Fields"
    5. Select "some" from the dropdown menu
    6. Enter this exact term into the text field: "_sku" (without the quotes of course)
    7. Deactivate "expand shortcodes" on the same page. Shortcodes search does not work well with woocommerce.
    8. Save your settings.
    9. Head to the tab "Search"
    10. Deactivate "exclude_from_search" if you would like to index product variations as well.
    11. Head back to the tab "indexing"
    12. Now click "Build the Index" and wait till the plugins finishes its work
    13. Done!

    Product Import Generator

    1. Select the menu item "SONAX Theme" on the left side
    2. A submenu opens below, where the item "Product Import Generator" can be selected
    3. You can now enter the SKUs / article numbers that you would like to import
    4. By clicking the "Next" button the system automatically generates a .csv file based on the product data from sonax.de
    5. Open the .csv file with a suitable tool such as Visual Studio Code
    6. Translate the texts within the tool and save the .csv file on your computer
    7. Return to the backend and select the menu item "Products" on the left side
    8. Click on the "Import" button on top and select the previously saved file from your computer
    9. Click "Continue" and check if every column is matched correctly
    10. Start the importer by clicking the corresponding button

    Translating the theme

    When translating the theme we highly recommend to use the child-theme. If you do not use the child-theme and translate the main/parent-theme your translation might get deleted when the theme is updated. By using the child-theme you circumvent this issue and the parent theme can be updated without interfering with your customizations.

    Creating a new translation

    1. Activate the child theme
    2. Install PoEdit from here
    3. Download the translation file (sonax.pot) from above
    4. Open PoEdit and setup the translation process
      1. Select "Edit a translation" and open the sonax.pot file
      2. When the translation file is opened click "Create New Translation" at the very bottom
      3. Select the language you want to translate to in the dialog
    5. PoEdit now shows every translatable term of the theme and you can start translating them.
    6. After you finished translating save the language files to the child theme
      1. Click "File -> Save as"
      2. Choose the folder "languages" in the child-theme (not the parent-theme!) or upload them to the child-theme folder "languages" if you translated locally.
    7. Done!

    Troubleshooting

    If your translation is not picked up by wordpress, you might have a mismatch between your translated language (in the .po and .mo file) and the selected language of wordpress. German translations for example have multiple different locales (e.g. de_DE, de_AT etc.). You can find the code of your selected language of wordpress in the html code:

    • Open up any customer facing site of your wordpress installation (e.g. the homepage)
    • Right click on the page and select "View Page Source" (Chrome or Firefox)
    • You will see the source code of your page
    • At the very top you should see the first line with the <html>-Tag
    • The tag will include an attribute "lang" with the exact locale, for example <html lang="de-DE" class="no-js no-svg">, which means your selected language is de_DE
    • Now make sure to name your translation files to match the "lang", in our example the selected language is de_DE, so the files should be named de_DE.po and de_DE.mo (Note the underscore!)

    Video walkthrough

    Updating a translation

    When introducing new features in the theme, new translatable terms might arise that have not been covered by your initial translation process yet. Luckily you can update your existing translation files to include the newly introduced terms so you can translate them.

    1. Download the latest translation file (sonax.pot) from above
    2. Open PoEdit and open your existing translation files (e.g. /child-theme/languages/de_DE.po)
    3. Update the existing file from the updated sonax.pot file:
      1. Select "Catalogue -> Update from POT File..."
      2. In the dialogue select the sonax.pot file and click "Open"
    4. PoEdit now shows every (new and updated) translatable term of the theme and you can start translating them.
    5. After you finished translating save the language files to the child theme
      1. Click "File -> Save as"
      2. Choose the folder "languages" in the child-theme (not the parent-theme!) or upload them to the child-theme folder "languages" if you translated locally.
    6. Done!

    Video walkthrough


    Authoring Content

    This part of the documentation has been moved to its own dedicated page.


    Customizing the theme

    Again when customizing or extending the theme we highly recommend to use the child-theme. Otherwise your customizations to the parent-theme will get deleted if you update the theme.

    For more information on how to customize a theme through a child theme visit the official wordpress documentation.