README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Mon, 22 Feb 2016 13:31:27 +0200
changeset 1909 6b76120bd2d3
parent 1905 fba288d59662
child 1912 8b81a8f0f692
permissions -rw-r--r--
Check for presents of :local: keyword.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1334
9bf0d5a1f0cf Include common header with quick links.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1247
diff changeset
     1
.. -*- coding: utf-8; -*-
9bf0d5a1f0cf Include common header with quick links.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1247
diff changeset
     2
.. include:: HEADER.rst
1247
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     3
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     4
================
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
 gavenkoa tips.
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
================
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
.. contents::
1905
fba288d59662 Include only local subsections into TOC. This prevent duplication of
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1896
diff changeset
     8
   :local:
1247
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
1337
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    10
About tips.
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    11
===========
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    12
1787
274aa5f80036 Referencing to defun site.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1642
diff changeset
    13
This site is a collection of tips that author (`Oleksandr Gavenko`_ AKA
274aa5f80036 Referencing to defun site.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1642
diff changeset
    14
gavenkoa_) was created during his life.
1337
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    15
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    16
Tips licence.
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    17
=============
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    18
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    19
You can do **anything** with these tips. Author take no any warranty.
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    20
1896
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    21
In countries where defined *public domain* you may assume that it is.
1337
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    22
1896
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    23
.. WARNING::
1337
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    24
1896
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    25
   Internetional copyright low (Berne Convention for the Protection of Literary
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    26
   and Artistic Works, Article 6bis) preserve some non-property (moral) rights
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    27
   for authors like:
1337
2bd47e0a87fa Add About and Licence statements.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1334
diff changeset
    28
1896
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    29
   * author shall have the right to claim authorship of the work
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    30
   * author shall have the right to object to any distortion, mutilation or
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    31
     other modification of, or other derogatory action in relation to, the said
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    32
     work, which would be prejudicial to his honor or reputation
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    33
c2448e4e25f4 Use special markup to warn about international copyright law.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1843
diff changeset
    34
   You are warned!
1247
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    35
1339
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    36
Make HTML version from sources.
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    37
===============================
1247
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    38
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    39
Install docutils package::
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    40
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    41
  $ sudo apt-get install docutils-common   # for Debian
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    42
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    43
and build::
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    44
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    45
  $ make html
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    46
  $ sensible-browser tips-html/index.html
1339
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    47
  $ sensible-browser tips-html/frame.html
1247
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    48
1642
ae7bc658a208 Check sources at.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1339
diff changeset
    49
Check sources at::
ae7bc658a208 Check sources at.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1339
diff changeset
    50
1843
8ad4fe7443f2 Point to defun.work to grab sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1787
diff changeset
    51
  $ hg clone http://hg.defun.work/tips
8ad4fe7443f2 Point to defun.work to grab sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1787
diff changeset
    52
8ad4fe7443f2 Point to defun.work to grab sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1787
diff changeset
    53
or::
1642
ae7bc658a208 Check sources at.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1339
diff changeset
    54
1843
8ad4fe7443f2 Point to defun.work to grab sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1787
diff changeset
    55
  $ hg clone http://hg.code.sf.net/u/gavenkoa/tips
8ad4fe7443f2 Point to defun.work to grab sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1787
diff changeset
    56
8ad4fe7443f2 Point to defun.work to grab sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1787
diff changeset
    57
or browser online at http://hg.defun.work/tips
1642
ae7bc658a208 Check sources at.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1339
diff changeset
    58
1339
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    59
Make CHM version from sources.
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    60
==============================
1247
cc97907e3123 Make HTML version.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    61
1339
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    62
Install docutils package::
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    63
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    64
  $ sudo apt-get install docutils-common   # for Debian
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    65
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    66
and build::
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    67
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    68
  $ make html
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    69
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    70
Enter to ``tips-html`` directory and compile with ``Microsoft's HTML Help SDK``.
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    71
Under Linux you can use ``Wine`` to run Windows binary.
04633ffa1cac Make CHM version from sources.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 1337
diff changeset
    72