aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/Developer
diff options
context:
space:
mode:
authorNicolas LÅ“uillet <nicolas@loeuillet.org>2015-10-22 17:02:06 +0200
committerNicolas LÅ“uillet <nicolas@loeuillet.org>2015-10-22 17:02:06 +0200
commite686b5e6fe37b476d70eeadce34616d65572245b (patch)
tree850a783f53671a3ad71892c5d6bd41d1c4595043 /docs/en/Developer
parent71200c4155490cb47b64172c3c2159f44cb80eca (diff)
parent59e91bc8931a386974a3817e9849aad1ca7fc186 (diff)
downloadwallabag-e686b5e6fe37b476d70eeadce34616d65572245b.tar.gz
wallabag-e686b5e6fe37b476d70eeadce34616d65572245b.tar.zst
wallabag-e686b5e6fe37b476d70eeadce34616d65572245b.zip
Merge pull request #1495 from wallabag/v2-docs
add docs
Diffstat (limited to 'docs/en/Developer')
-rw-r--r--docs/en/Developer/create_new_theme.rst4
-rw-r--r--docs/en/Developer/git_repo.rst29
-rw-r--r--docs/en/Developer/write_config_files.rst52
3 files changed, 85 insertions, 0 deletions
diff --git a/docs/en/Developer/create_new_theme.rst b/docs/en/Developer/create_new_theme.rst
new file mode 100644
index 00000000..5731eb11
--- /dev/null
+++ b/docs/en/Developer/create_new_theme.rst
@@ -0,0 +1,4 @@
1Create new theme
2================
3
4TODO
diff --git a/docs/en/Developer/git_repo.rst b/docs/en/Developer/git_repo.rst
new file mode 100644
index 00000000..4fa5c608
--- /dev/null
+++ b/docs/en/Developer/git_repo.rst
@@ -0,0 +1,29 @@
1Git repository
2==============
3
4If you wish to contribute to the project by suggesting new features or
5by fixing some bugs, please follow the recommendations below regarding
6the git repository available at https://github.com/wallabag/wallabag.
7
8Current state
9-------------
10
11To manage the different versions of wallabag, we use Git.
12
13There are multiple branches for the source code of wallabag web app:
14
15- ``master`` branch : this is the stable branch, downloaded by those
16 who wish to install wallabag for their own use.
17- ``dev`` branch : before being added on ``master`` branch, all bug
18 fixes and new features must go on that branch. This branch is not
19 recommended for production use.
20- ``v2`` branch : this is the branch for a revamp of wallabag.
21 A whole chapter is to be focused on it.
22
23Workflow
24--------
25
26All the rules for contributing to the git repository are in the
27`CONTRIBUTING.md file of
28wallabag <https://github.com/wallabag/wallabag/blob/master/CONTRIBUTING.md>`__.
29Please read carefully this file before you make any change.
diff --git a/docs/en/Developer/write_config_files.rst b/docs/en/Developer/write_config_files.rst
new file mode 100644
index 00000000..c1ea61df
--- /dev/null
+++ b/docs/en/Developer/write_config_files.rst
@@ -0,0 +1,52 @@
1Write config files
2==================
3
4wallabag can use specific site config files to parse website articles.
5These files are stored in the
6```inc/3rdparty/site_config/standard`` <https://github.com/wallabag/wallabag/tree/master/inc/3rdparty/site_config/standard>`__
7folder.
8
9The format used for these files is
10`XPath <http://www.w3.org/TR/xpath20/>`__. Look at some examples in the
11folder.
12
13Automatic config files generation
14---------------------------------
15
16Fivefilters has created a `very useful
17tool <http://siteconfig.fivefilters.org/>`__ to create config files. You
18just type in the adress of the article to work on with, and you select
19the area containing the content you want.
20
21.. figure:: https://lut.im/RNaO7gGe/l9vRnO1b
22 :alt: siteconfig
23
24 siteconfig
25| You should confirm this area by trying with other articles.
26| When you got the right area, just click on *Download Full-Text RSS
27site config* to download your file.
28
29Manual config file generation
30-----------------------------
31
32If Fivefilters tool doesn't work correctly, take a look at the source
33(Ctrl + U on Firefox and Chromium). Search for your content and get the
34``class`` or the ``id`` attribute of the area containing what you want.
35
36Once you've got the id or class, you can write for example one or
37another of these lines:
38
39::
40
41 body: //div[@class='myclass']
42 body: //div[@id='myid']
43
44Then, test you file. If you got the right content but you want to strip
45unnecessary parts, do:
46
47::
48
49 strip: //div[@class='hidden']
50
51You can look at other options for siteconfig files
52`here <http://help.fivefilters.org/customer/portal/articles/223153-site-patterns>`__.