Skip to content

Commit c0af649

Browse files
committed
Added Tutorial drafts that as of now just outline topics yet to be written.
1 parent 200ef00 commit c0af649

File tree

4 files changed

+114
-3
lines changed

4 files changed

+114
-3
lines changed

Tutorial-beginner.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
This is just a draft that outlines topics yet to be written.
2+
TODO: see the CEF Tutorial wiki
3+
4+
# Tutorial
5+
6+
7+
## Download and install
8+
9+
* download from Releases/
10+
* types of packages for each platform
11+
* install from PyPI using pip (Win/Mac)
12+
13+
14+
## Simple example using wxPython
15+
16+
* paste code, most simple example loading www.google.com,
17+
shouldn't be more than 20 lines.
18+
19+
* Explain all functions from the example:
20+
- initialize()
21+
you can call initialize and shutdown only once
22+
- shutdown()
23+
- to exit cleanly
24+
- cookies or other storage might not be saved (flushed every 30 secs)
25+
process might freeze (XP experienced)
26+
- messageloop
27+
- messageloopwork
28+
- messageloop faster, but this one allows integration into
29+
existing message loop
30+
31+
* ExceptHook in examples so that all processes are closed in
32+
case of a python error
33+
34+
* there are more examples in the examples/ directory.
35+
36+
37+
## Settings
38+
39+
* Describe a few most commonly used settings.
40+
* Command-line switches from Chromium.
41+
* Disable developer-tools or context menu
42+
- application settings context menu dict.
43+
44+
45+
## Documentation and help
46+
47+
* see the api/ directory.
48+
- API categories.md and API full index.md
49+
will help you navigate through API.
50+
51+
* knowledge base document
52+
53+
* "Search this repository" to search through documentation and code
54+
55+
* Try google "cef +search-phrase"
56+
57+
* Forum - ask questions and report problems there, not in Issue Tracker
58+
59+
* See Tutorial-intermediate.

Tutorial-intermediate.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
This is just a draft that outlines topics yet to be written.
2+
TODO: see the CEF General Usage and Javascript Integration wikis.
3+
4+
# Tutorial - intermediate
5+
6+
* Read first Tutorial-beginner.
7+
8+
9+
## Architecture
10+
11+
* subprocess.exe
12+
* browser process
13+
* renderer process
14+
* gpu process
15+
* zygote on linux
16+
* Describe browser process threads
17+
18+
19+
## Handlers
20+
21+
* What are handlers.
22+
* Handler callbacks may be called either on UI thread or IO thread.
23+
Use functions for posting tasks when need to access UI thread from IO thread.
24+
* Example code how to use handlers - use base code from Tutorial-beginner.
25+
- keyboard handler F12 devtools and F5
26+
- loadhandler onloadstart to insert js to all pages
27+
- loadhandler onloadingstatechange when page completed loading
28+
- onloaderror
29+
30+
31+
## Javascript integration
32+
33+
* how to expose function to js
34+
* how to communicate two-way js<>python
35+
* callbacks
36+
* js errors handling
37+
* example code how to use - use base code from Tutorial-beginner.
38+
39+
40+
## Plugins
41+
42+
* Load PPAPI flash plugin
43+
- console window issue on Windows in CEF 47, possible solutions
44+
45+
46+
## Off-screen rendering
47+
48+
* Describe difference between windowed rendering and off-screen rendering.
49+
* Panda3D and Kivy - offscreen
50+
* The rest - windowed
51+
* Describe render handler callbacks in kivy - how this works.
52+

tools/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,11 @@ pip install -r requirements.txt
1111
apidocs.py - generate API docs from Cython sources
1212
automate.py - download CEF binaries, build and optionally install/run
1313
build.py - build the cefpython module
14-
doctoc.py - generate table of contents for all .md in docs/
1514
make_distrib.py - make distribution packages (msi, wheel, deb pkg and more)
1615
run.py - rebuild and install if changed, and run example(s)
17-
setpython.bat - change python installation in PATH (Windows)
18-
setpython.sh - change python installation in PATH (Linux and Mac)
1916
test_distrib.py - for all distribution packages install each of them
2017
and run unit tests and all examples
18+
toc.py - generate Table of contents for .md files
2119
translator.py - generate code from the CEF header files
2220
unittests.py - run unit tests
2321
```

tools/toc.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Usage:
66
toc.py FILE
77
toc.py DIR
8+
9+
To ignore file when generating TOC, put an empty line just before H1.
810
"""
911

1012
import os

0 commit comments

Comments
 (0)