ruiaraujo / dokuwiki-template-prsnl10 Goto Github PK

  I. About

    "prsnl10" is a minimalist template for DokuWiki. It is designed to use
    DokuWiki as CMS for portfolio websites and other "non-wiki" purposes. The
    name means "personal template 2010" because it was created the personal
    website of Andreas Haerter [1] in 2010.

    Website:     <http://www.dokuwiki.org/template:prsnl10>
    Maintainer:  SYN Systems <http://syn-systems.com/>
    Contact:     See "IV. Support" and "V. Contact".

    [1] <http://andreas-haerter.com/>



  II. Installation and update

    The installation works as described [1] on DokuWiki.org. Extract the
    downloaded archive into your DokuWiki's "lib/tpl/" folder. Then select the
    template in the Config Manager by adjusting the template option.

    See the prsnl10 template website for update instructions [2].

    [1] <http://www.dokuwiki.org/template>
    [2] <http://www.dokuwiki.org/template:prsnl10#update>



  III. Customizing the template

    In order to make updates of your installed "prsnl10" template easy, follow
    these hints for customizing the template:

    - Place your files in "prsnl10/user"
      The place for *all* userdefined, custom stuff is "prsnl10/user".
      Reason: this folder will not be touched on updates. Therefore you may
      delete everything except "prsnl10/user" and copy all new files into
      "prsnl10/" to update without loosing your changes. Do not forget to
      empty your browser's cache afterwards.

    - Own logo
      If you want to replace the default text showed in the headline, simply
      create a "logo.[png|gif|jpg]" in "prsnl10/user". The template recognizes
      the file automatically and will use it instead of the default text. Do not
      forget to empty your browser's cache afterwards.
      Hint: If you want to use a text-based logo, you might find the font
            files [1] for "Droid Sans" out of Google's Webfont Directory [2]
            useful.

    - Own favicon
      If you want to replace the default favicon, simply create a "favicon.ico"
      in "prsnl10/user". The template recognizes the file automatically and
      will use it instead of the default one. Do not forget to empty your
      browser's cache afterwards. By the way: you might find the online
      FavIcon Generator [3] useful.
      Note: "favicon.png" is also possible but not recommended (because it is
            not supported by older MSIE versions).

    - Own CSS
      To apply additional CSS rules, edit "prsnl10/user/screen.css"
      (influences normal layout) and/or "prsnl10/user/print.css" (influences
      print layout) and/or "prsnl10/user/rtl.css" (influences "right-to-left"
      languages like Hebrew). These files will be included automatically (as the
      last ones for the relevant media, therefore you are able to overrule
      existing styles). Do not forget to empty your browser's cache afterwards.

    - Own JavaScript
      To load additional JavaScript, edit "prsnl10/user/user.js". Do not
      forget to empty your browser's cache afterwards.
      ATTENTION: You have to activate the template option "prsnl10_loaduserjs"
                 (->"Load 'prsnl10/user/user.js'?") in the DokuWiki Config
                 Manager!

    - Web analytics software (Piwik, Google Analytics etc.)
      Tools like Piwik and Google Analytics normally provide a small code
      snippet ("tag") which you have to include at your website to make
      everything work. If you want to use such software with this template, have
      a look at "prsnl10/user/tracker.php". This file exists to make it easier
      for you. You don't have to deliberate where you have to copy and paste the
      code, simply do it there.

    - Own Apple Touch Icon
      If you want to replace the default Apple Touch Icon, simply create a
      "apple-touch-icon.png" in "prsnl10/user". The template recognizes the
      file automatically and will use it instead of the default one. Have a
      look at Apple's developer database (cf. "Configuring Web Applications"[4])
      if you need more information.

    [1] <http://www.google.com/webfonts/family?family=Droid+Sans>
    [2] <http://j.mp/inYDGL>
    [3] <http://tools.dynamicdrive.com/favicon/>
    [4] <http://j.mp/sx3NMT>



  IV. Support

    If you need help, check the FAQ [1] and try to find useful information by
    using the DokuWiki Search page [2]. If you found nothing helpful, ask your
    question at the DokuWiki forum [3] (preferred) or IRC channel [4].

    [1] <http://www.dokuwiki.org/template:prsnl10#faq>
    [2] <http://search.dokuwiki.org/>
    [3] <http://forum.dokuwiki.org/>
    [4] <http://www.dokuwiki.org/irc>



  V. Contact

    If you think you have found a bug or have a useful idea (a.k.a. "feature
    request"), create an issue [1] on GitHub (preferred), or contact us by
    mail [2].

    Feel free to submit patches as GitHub pull requests (preferred) or by mail
    as well. However, please try to respect the DokuWiki coding style [3] as
    this template follows its rules.

    [1] <https://github.com/syn-systems/dokuwiki-template-prsnl10/issues>
    [2] SYN Systems <[email protected]>
    [3] <http://www.dokuwiki.org/devel:coding_style>



  VI. Other notes

    If you like this free project, you might buy us a coffee [1], or get some
    cool QR Code merchandise [2]. Thank you! :-)

    Do not hesitate to contact SYN Systems [3] if you need professional support
    or if you think we are the ones to get your project done.

    [1] <http://syn-systems.com/donate/dokuwiki-template-prsnl10/>
    [2] <http://goqr.me/>
    [3] <http://syn-systems.com/>



  VII. Explanatory notes about the dirs of this template

    - "prsnl10/conf"
      Contains some configuration files (do NOT edit them!), especially
        - default.php: default settings [1]
        - metadata.php: configuration metadata [2]

    - "prsnl10/lang"
      Language files (subdir names = language code). You may copy the English
      language files and translate them if your language is missing. Simply send
      us the translated files (cf. "V. Contact") and I will include them in the
      next release :-D.

    - "prsnl10/css"
      All Cascading Style Sheets (CSS). See my tutorial [3] for more information
      about how the CSS is handled.

    - "prsnl10/images"
      Images files.

    - "prsnl10/js"
      JavaScript files.

    - "prsnl10/user"
      Place for userdefined stuff. E.g. if you want use an own logo, simply copy
      a logo.[png|gif|jpg] in here. See "III. Customizing the template" for
      details.

    [1] <http://www.dokuwiki.org/devel:configuration#default_settings>
    [2] <http://www.dokuwiki.org/devel:configuration#configuration_metadata>
    [3] <http://j.mp/eq8zSo>



  VIII. Creation transcript

    Some developers may find this interesting. Additionally, I am very oblivious
    :-P.

    In principle, I followed my own tutorial [1]. There was just no "starter"
    template [2] when "prsnl10" was created. Therefore, after ~1 year, I
    switched the CSS base from DokuWiki's default template to the starter
    template, but the markup of "main.php" is still based on the default
    template's "main.php".

    [1] <http://j.mp/eq8zSo>
    [2] <http://www.dokuwiki.org/template:starter>