pylowiki
| rev 22 | rev 23 | ||||
|---|---|---|---|---|---|
| 79 | Bitbucket.org allows repository branching and merging. I will review all submis | 79 | Bitbucket.org allows repository branching and merging. I will review all submis | ||
| > | sions and patches and intergrate into the main branch. | > | sions and patches and intergrate into the main branch. | ||
| 80 | 80 | ||||
| t | t | 81 | IRC | ||
| 82 | irc.freenode.net | ||||
| 83 | Channel | ||||
| 84 | #pylowiki | ||||
| 81 | 85 | ||||
| 82 | 86 | ||||
| rev 21 | rev 22 | ||||
|---|---|---|---|---|---|
| 12 | .. pull-quote:: | 12 | .. pull-quote:: | ||
| 13 | "Users are able to browse, search, edit, preview, and submit all from the same | 13 | "Users are able to browse, search, edit, preview, and submit all from the same | ||
| > | page!" | > | page!" | ||
| n | 14 | I am just testing this. It seems to work well! | n | ||
| 15 | 14 | ||||
| n | 16 | cool. | n | 15 | The original goal of *Pylowiki* was to create an advanced same page, section edi |
| > | t and preview, wiki solution. We succeeded! | ||||
| 16 | |||||
| 17 | Users are able to search, browse, and view articles. If they see a problem or so | ||||
| > | mething they wish to make an addition, they may edit and save changes on the sam | ||||
| > | e page. | ||||
| 18 | |||||
| 19 | During the edit, a preview of the result will be displayed real-time and in plac | ||||
| > | e. | ||||
| 20 | |||||
| 21 | Users can see how the page will look *before* submitting. | ||||
| 17 | 22 | ||||
| 18 | 23 | ||||
| 25 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defin | 30 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defin | ||
| > | e Pylowiki we must first define *Pylons* and *wiki*. | > | e Pylowiki we must first define *Pylons* and *wiki*. | ||
| 26 | 31 | ||||
| n | 27 | **def Pylons( pie-lons ):** | n | 32 | **def Pylons( pahy-lons ):** |
| 28 | 33 | ||||
| 29 | Pylons is a lightweight python web framework emphasizing flexibility and rapid | 34 | Pylons is a lightweight python web framework emphasizing flexibility and rapid | ||
| > | development. | > | development. | ||
| 37 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ | 42 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ | ||
| 38 | 43 | ||||
| t | 39 | **def Pylowiki( pie-loh-wik-ee ):** | t | 44 | **def Pylowiki( pahy - loh - wik-ee ):** |
| 40 | 45 | ||||
| 41 | A wiki built using the Pylons framework. | 46 | A wiki built using the Pylons framework. | ||
| rev 20 | rev 21 | ||||
|---|---|---|---|---|---|
| 12 | .. pull-quote:: | 12 | .. pull-quote:: | ||
| 13 | "Users are able to browse, search, edit, preview, and submit all from the same | 13 | "Users are able to browse, search, edit, preview, and submit all from the same | ||
| > | page!" | > | page!" | ||
| n | n | 14 | I am just testing this. It seems to work well! | ||
| 14 | 15 | ||||
| t | 15 | The original goal of *Pylowiki* was to create an advanced same page, section edi | t | 16 | cool. |
| > | t and preview, wiki solution. We succeeded! | ||||
| 16 | |||||
| 17 | Users are able to search, browse, and view articles. If they see a problem or so | ||||
| > | mething they wish to make an addition, they may edit and save changes on the sam | ||||
| > | e page. | ||||
| 18 | |||||
| 19 | During the edit, a preview of the result will be displayed real-time and in plac | ||||
| > | e. | ||||
| 20 | |||||
| 21 | Users can see how the page will look *before* submitting. | ||||
| 22 | 17 | ||||
| 23 | 18 | ||||
| rev 19 | rev 20 | ||||
|---|---|---|---|---|---|
| 2 | ================== | 2 | ================== | ||
| 3 | 3 | ||||
| t | 4 | asdfasdfasdfsdafasdfasdfsadfsdf | t | ||
| 5 | .. contents:: Sections | 4 | .. contents:: Sections | ||
| 6 | 5 | ||||
| rev 18 | rev 19 | ||||
|---|---|---|---|---|---|
| 2 | ================== | 2 | ================== | ||
| 3 | 3 | ||||
| t | t | 4 | asdfasdfasdfsdafasdfasdfsadfsdf | ||
| 4 | .. contents:: Sections | 5 | .. contents:: Sections | ||
| 5 | 6 | ||||
| rev 17 | rev 18 | ||||
|---|---|---|---|---|---|
| 2 | ================== | 2 | ================== | ||
| 3 | 3 | ||||
| t | 4 | asdfasdfasdfsdafasdfasdfsadfsdf | t | ||
| 5 | .. contents:: Sections | 4 | .. contents:: Sections | ||
| 6 | 5 | ||||
| rev 15 | rev 16 | ||||
|---|---|---|---|---|---|
| 2 | ================== | 2 | ================== | ||
| 3 | 3 | ||||
| t | t | 4 | asdfasdfasdfsdafasdfasdfsadfsdf | ||
| 4 | .. contents:: Sections | 5 | .. contents:: Sections | ||
| 5 | 6 | ||||
| rev 14 | rev 15 | ||||
|---|---|---|---|---|---|
| 30 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defin | 30 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defin | ||
| > | e Pylowiki we must first define *Pylons* and *wiki*. | > | e Pylowiki we must first define *Pylons* and *wiki*. | ||
| 31 | 31 | ||||
| n | 32 | **def Pylons( pahy-lons ):** | n | 32 | **def Pylons( pie-lons ):** |
| 33 | 33 | ||||
| 34 | Pylons is a lightweight python web framework emphasizing flexibility and rapid | 34 | Pylons is a lightweight python web framework emphasizing flexibility and rapid | ||
| > | development. | > | development. | ||
| 42 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ | 42 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ | ||
| 43 | 43 | ||||
| t | 44 | **def Pylowiki( pahy - loh - wik-ee ):** | t | 44 | **def Pylowiki( pie-loh-wik-ee ):** |
| 45 | 45 | ||||
| 46 | A wiki built using the Pylons framework. | 46 | A wiki built using the Pylons framework. | ||
| rev 13 | rev 14 | ||||
|---|---|---|---|---|---|
| t | 1 | NRoonx <a href="http://roeepdrzxbct.com/">roeepdrzxbct</a>, [url=http://qgmcryj | t | 1 | About Pylowiki |
| > | ovjpa.com/]qgmcryjovjpa[/url], [link=http://ryqvqwylomyk.com/]ryqvqwylomyk[/link | ||||
| > | ], http://ctjqwwilsrhu.com/ | ||||
| 2 | ================== | ||||
| 3 | |||||
| 4 | .. contents:: Sections | ||||
| 5 | |||||
| 6 | |||||
| 7 | |||||
| 8 | Pylowiki's Primary Objective | ||||
| 9 | ============================= | ||||
| 10 | |||||
| 11 | |||||
| 12 | .. pull-quote:: | ||||
| 13 | "Users are able to browse, search, edit, preview, and submit all from the same | ||||
| > | page!" | ||||
| 14 | |||||
| 15 | The original goal of *Pylowiki* was to create an advanced same page, section edi | ||||
| > | t and preview, wiki solution. We succeeded! | ||||
| 16 | |||||
| 17 | Users are able to search, browse, and view articles. If they see a problem or so | ||||
| > | mething they wish to make an addition, they may edit and save changes on the sam | ||||
| > | e page. | ||||
| 18 | |||||
| 19 | During the edit, a preview of the result will be displayed real-time and in plac | ||||
| > | e. | ||||
| 20 | |||||
| 21 | Users can see how the page will look *before* submitting. | ||||
| 22 | |||||
| 23 | |||||
| 24 | |||||
| 25 | |||||
| 26 | |||||
| 27 | What does the name Pylowiki mean? | ||||
| 28 | ========================================= | ||||
| 29 | |||||
| 30 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defin | ||||
| > | e Pylowiki we must first define *Pylons* and *wiki*. | ||||
| 31 | |||||
| 32 | **def Pylons( pahy-lons ):** | ||||
| 33 | |||||
| 34 | Pylons is a lightweight python web framework emphasizing flexibility and rapid | ||||
| > | development. | ||||
| 35 | |||||
| 36 | `. . . more about Pylons <http://pylonshq.com/>`_ | ||||
| 37 | |||||
| 38 | **def wiki( wik-ee ):** | ||||
| 39 | |||||
| 40 | A collaborative website whose content can be edited by anyone who has access | ||||
| > | to it. | ||||
| 41 | |||||
| 42 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ | ||||
| 43 | |||||
| 44 | **def Pylowiki( pahy - loh - wik-ee ):** | ||||
| 45 | |||||
| 46 | A wiki built using the Pylons framework. | ||||
| 47 | |||||
| 48 | * Pylo wiki | ||||
| 49 | * Pile-O-wiki | ||||
| 50 | * Pile of wiki | ||||
| 51 | |||||
| 52 | |||||
| 53 | What mark-up does Pylowiki use? | ||||
| 54 | ===================================== | ||||
| 55 | |||||
| 56 | Pylowiki uses `reStructured Text (reST) <http://docutils.sourceforge.net/docs/us | ||||
| > | er/rst/quickref.html>`_ as its wiki mark-up. | ||||
| 57 | |||||
| 58 | How does Pylowiki render mark-up for real-time preview? | ||||
| 59 | ========================================================== | ||||
| 60 | Pylowiki uses ajax to send reST mark-up to the web server. The web server accep | ||||
| > | ts reST and converts it to HTML. The HTML is sent back to the browser and appea | ||||
| > | rs on the page in place and in real-time! | ||||
| 61 | |||||
| 62 | Why is real-time preview important? | ||||
| 63 | ```````````````````````````````````````````` | ||||
| 64 | Real-time preview of the users wiki mark-up is important because of the followin | ||||
| > | g reasons: | ||||
| 65 | |||||
| 66 | * Users get feedback before they save changes. | ||||
| 67 | * Users do not have to leave the article to make a change, they may edit while t | ||||
| > | he browse. | ||||
| 68 | * It is faster and leads to less consecutive edits by the same user. | ||||
| 69 | * Its fun and futuristic! | ||||
| 70 | |||||
| 71 | |||||
| 72 | I'd like to help, what could I do? | ||||
| 73 | ========================================== | ||||
| 74 | |||||
| 75 | Thank you! Take a look at the `todo list </todo>`_ and see about implementing so | ||||
| > | mething. | ||||
| 76 | |||||
| 77 | You can also usability test, bug test, feature test Pylowiki. | ||||
| 78 | |||||
| 79 | Bitbucket.org allows repository branching and merging. I will review all submis | ||||
| > | sions and patches and intergrate into the main branch. | ||||
| 80 | |||||
| 81 | |||||
| 82 | |||||
| 83 | Where can I get the sourcecode? | ||||
| 84 | ====================================== | ||||
| 85 | |||||
| 86 | Yes, Pylowiki is opensourced. The hg mercurial repository is located at: | ||||
| 87 | |||||
| 88 | * http://bitbucket.org/russellballestrini/pylowiki | ||||
| 89 | |||||
| 90 | |||||
| 91 | Installation and Setup | ||||
| 92 | ====================== | ||||
| 93 | |||||
| 94 | #. Setup a working pylons virtualenv, review the pylons wiki to get started. | ||||
| 95 | |||||
| 96 | http://pylonshq.com/docs/en/1.0/gettingstarted/ | ||||
| 97 | |||||
| 98 | #. Acquire the Pylowiki source:: | ||||
| 99 | |||||
| 100 | hg clone ssh://hg@bitbucket.org/russellballestrini/pylowiki | ||||
| 101 | |||||
| 102 | #. Navigate to the pylowiki directory and create a config file as follows:: | ||||
| 103 | |||||
| 104 | paster make-config Pylowiki config.ini | ||||
| 105 | |||||
| 106 | #. Tweak the config file as appropriate and then setup the application:: | ||||
| 107 | |||||
| 108 | paster setup-app config.ini | ||||
| 109 | |||||
| 110 | #. Test the install by running the dev paste server:: | ||||
| 111 | |||||
| 112 | paster serve --reload config.ini | ||||
| 113 | |||||
| 114 | #. Navigate a browser to http://127.0.0.1:5000 | ||||
| rev 11 | rev 12 | ||||
|---|---|---|---|---|---|
| t | 1 | GkjlbB <a href="http://socwsuvusegt.com/">socwsuvusegt</a>, [url=http://apicbpg | t | 1 | NRoonx <a href="http://roeepdrzxbct.com/">roeepdrzxbct</a>, [url=http://qgmcryj |
| > | uwpfd.com/]apicbpguwpfd[/url], [link=http://vmragafmpcns.com/]vmragafmpcns[/link | > | ovjpa.com/]qgmcryjovjpa[/url], [link=http://ryqvqwylomyk.com/]ryqvqwylomyk[/link | ||
| > | ], http://iomlfnlarktw.com/ | > | ], http://ctjqwwilsrhu.com/ | ||
| rev 9 | rev 10 | ||||
|---|---|---|---|---|---|
| t | 1 | About Pylowiki | t | 1 | GkjlbB <a href="http://socwsuvusegt.com/">socwsuvusegt</a>, [url=http://apicbpg |
| > | uwpfd.com/]apicbpguwpfd[/url], [link=http://vmragafmpcns.com/]vmragafmpcns[/link | ||||
| > | ], http://iomlfnlarktw.com/ | ||||
| 2 | ================== | ||||
| 3 | |||||
| 4 | .. contents:: Sections | ||||
| 5 | |||||
| 6 | |||||
| 7 | |||||
| 8 | Pylowiki's Primary Objective | ||||
| 9 | ============================= | ||||
| 10 | |||||
| 11 | |||||
| 12 | .. pull-quote:: | ||||
| 13 | "Users are able to browse, search, edit, preview, and submit all from the same | ||||
| > | page!" | ||||
| 14 | |||||
| 15 | The original goal of *Pylowiki* was to create an advanced same page, section edi | ||||
| > | t and preview, wiki solution. We succeeded! | ||||
| 16 | |||||
| 17 | Users are able to search, browse, and view articles. If they see a problem or so | ||||
| > | mething they wish to make an addition, they may edit and save changes on the sam | ||||
| > | e page. | ||||
| 18 | |||||
| 19 | During the edit, a preview of the result will be displayed real-time and in plac | ||||
| > | e. | ||||
| 20 | |||||
| 21 | Users can see how the page will look *before* submitting. | ||||
| 22 | |||||
| 23 | |||||
| 24 | |||||
| 25 | |||||
| 26 | |||||
| 27 | What does the name Pylowiki mean? | ||||
| 28 | ========================================= | ||||
| 29 | |||||
| 30 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defin | ||||
| > | e Pylowiki we must first define *Pylons* and *wiki*. | ||||
| 31 | |||||
| 32 | **def Pylons( pahy-lons ):** | ||||
| 33 | |||||
| 34 | Pylons is a lightweight python web framework emphasizing flexibility and rapid | ||||
| > | development. | ||||
| 35 | |||||
| 36 | `. . . more about Pylons <http://pylonshq.com/>`_ | ||||
| 37 | |||||
| 38 | **def wiki( wik-ee ):** | ||||
| 39 | |||||
| 40 | A collaborative website whose content can be edited by anyone who has access | ||||
| > | to it. | ||||
| 41 | |||||
| 42 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ | ||||
| 43 | |||||
| 44 | **def Pylowiki( pahy - loh - wik-ee ):** | ||||
| 45 | |||||
| 46 | A wiki built using the Pylons framework. | ||||
| 47 | |||||
| 48 | * Pylo wiki | ||||
| 49 | * Pile-O-wiki | ||||
| 50 | * Pile of wiki | ||||
| 51 | |||||
| 52 | |||||
| 53 | What mark-up does Pylowiki use? | ||||
| 54 | ===================================== | ||||
| 55 | |||||
| 56 | Pylowiki uses `reStructured Text (reST) <http://docutils.sourceforge.net/docs/us | ||||
| > | er/rst/quickref.html>`_ as its wiki mark-up. | ||||
| 57 | |||||
| 58 | How does Pylowiki render mark-up for real-time preview? | ||||
| 59 | ========================================================== | ||||
| 60 | Pylowiki uses ajax to send reST mark-up to the web server. The web server accep | ||||
| > | ts reST and converts it to HTML. The HTML is sent back to the browser and appea | ||||
| > | rs on the page in place and in real-time! | ||||
| 61 | |||||
| 62 | Why is real-time preview important? | ||||
| 63 | ```````````````````````````````````````````` | ||||
| 64 | Real-time preview of the users wiki mark-up is important because of the followin | ||||
| > | g reasons: | ||||
| 65 | |||||
| 66 | * Users get feedback before they save changes. | ||||
| 67 | * Users do not have to leave the article to make a change, they may edit while t | ||||
| > | he browse. | ||||
| 68 | * It is faster and leads to less consecutive edits by the same user. | ||||
| 69 | * Its fun and futuristic! | ||||
| 70 | |||||
| 71 | |||||
| 72 | I'd like to help, what could I do? | ||||
| 73 | ========================================== | ||||
| 74 | |||||
| 75 | Thank you! Take a look at the `todo list </todo>`_ and see about implementing so | ||||
| > | mething. | ||||
| 76 | |||||
| 77 | You can also usability test, bug test, feature test Pylowiki. | ||||
| 78 | |||||
| 79 | Bitbucket.org allows repository branching and merging. I will review all submis | ||||
| > | sions and patches and intergrate into the main branch. | ||||
| 80 | |||||
| 81 | |||||
| 82 | |||||
| 83 | Where can I get the sourcecode? | ||||
| 84 | ====================================== | ||||
| 85 | |||||
| 86 | Yes, Pylowiki is opensourced. The hg mercurial repository is located at: | ||||
| 87 | |||||
| 88 | * http://bitbucket.org/russellballestrini/pylowiki | ||||
| 89 | |||||
| 90 | |||||
| 91 | Installation and Setup | ||||
| 92 | ====================== | ||||
| 93 | |||||
| 94 | #. Setup a working pylons virtualenv, review the pylons wiki to get started. | ||||
| 95 | |||||
| 96 | http://pylonshq.com/docs/en/1.0/gettingstarted/ | ||||
| 97 | |||||
| 98 | #. Acquire the Pylowiki source:: | ||||
| 99 | |||||
| 100 | hg clone ssh://hg@bitbucket.org/russellballestrini/pylowiki | ||||
| 101 | |||||
| 102 | #. Navigate to the pylowiki directory and create a config file as follows:: | ||||
| 103 | |||||
| 104 | paster make-config Pylowiki config.ini | ||||
| 105 | |||||
| 106 | #. Tweak the config file as appropriate and then setup the application:: | ||||
| 107 | |||||
| 108 | paster setup-app config.ini | ||||
| 109 | |||||
| 110 | #. Test the install by running the dev paste server:: | ||||
| 111 | |||||
| 112 | paster serve --reload config.ini | ||||
| 113 | |||||
| 114 | #. Navigate a browser to http://127.0.0.1:5000 | ||||
| rev 8 | rev 9 | ||||
|---|---|---|---|---|---|
| 9 | ============================= | 9 | ============================= | ||
| 10 | 10 | ||||
| n | 11 | The original goal of *Pylowiki* was to create an advanced same page, section ed | n | ||
| > | it and preview, wiki solution. We succeeded! | ||||
| 12 | |||||
| 13 | 11 | ||||
| 14 | .. pull-quote:: | 12 | .. pull-quote:: | ||
| 15 | "Users are able to browse, search, edit, preview, and submit all from the same | 13 | "Users are able to browse, search, edit, preview, and submit all from the same | ||
| > | page!" | > | page!" | ||
| 16 | 14 | ||||
| t | t | 15 | The original goal of *Pylowiki* was to create an advanced same page, section edi | ||
| > | t and preview, wiki solution. We succeeded! | ||||
| 16 | |||||
| 17 | Users are able to search, browse, and view articles. If they see a problem or so | 17 | Users are able to search, browse, and view articles. If they see a problem or so | ||
| > | mething they wish to add, they may edit and save changes on the same page. | > | mething they wish to make an addition, they may edit and save changes on the sam | ||
| > | e page. | ||||
| 18 | 18 | ||||
| 19 | During the edit, a preview of the result will be displayed real-time and in plac | 19 | During the edit, a preview of the result will be displayed real-time and in plac | ||
| > | e. | > | e. | ||
| rev 7 | rev 8 | ||||
|---|---|---|---|---|---|
| 11 | The original goal of *Pylowiki* was to create an advanced same page, section ed | 11 | The original goal of *Pylowiki* was to create an advanced same page, section ed | ||
| > | it and preview, wiki solution. We succeeded! | > | it and preview, wiki solution. We succeeded! | ||
| 12 | 12 | ||||
| n | 13 | Users are able to ... | n | 13 | |
| 14 | ````````````````````````` | ||||
| 15 | .. pull-quote:: | 14 | .. pull-quote:: | ||
| t | 16 | "Browse, Search, Edit, Preview, and Submit all from the same page!" | t | 15 | "Users are able to browse, search, edit, preview, and submit all from the same |
| > | page!" | ||||
| 17 | 16 | ||||
| 18 | Users are able to search, browse, and view articles. If they see a problem or so | 17 | Users are able to search, browse, and view articles. If they see a problem or so | ||
| > | mething they wish to add, they may edit and save changes on the same page. | > | mething they wish to add, they may edit and save changes on the same page. | ||
| rev 6 | rev 7 | ||||
|---|---|---|---|---|---|
| 13 | Users are able to ... | 13 | Users are able to ... | ||
| 14 | ````````````````````````` | 14 | ````````````````````````` | ||
| n | 15 | * Search, Browse, and View articles. | n | 15 | .. pull-quote:: |
| 16 | * Edit and Save changes on the same page. | 16 | "Browse, Search, Edit, Preview, and Submit all from the same page!" | ||
| 17 | * Preview the result real-time and in place. See the page *before* submitting. | ||||
| 18 | 17 | ||||
| t | 19 | **Search, Browse, Edit, Preview, and Submit from the same page!** | t | 18 | Users are able to search, browse, and view articles. If they see a problem or so |
| > | mething they wish to add, they may edit and save changes on the same page. | ||||
| 19 | |||||
| 20 | During the edit, a preview of the result will be displayed real-time and in plac | ||||
| > | e. | ||||
| 21 | |||||
| 22 | Users can see how the page will look *before* submitting. | ||||
| 23 | |||||
| 24 | |||||
| 25 | |||||
| 20 | 26 | ||||
| 21 | 27 | ||||
| rev 5 | rev 6 | ||||
|---|---|---|---|---|---|
| 13 | Users are able to ... | 13 | Users are able to ... | ||
| 14 | ````````````````````````` | 14 | ````````````````````````` | ||
| n | 15 | * Search, Browse, and View articles. | n | 15 | * Search, Browse, and View articles. |
| 16 | * Edit and Save changes on the same page. | 16 | * Edit and Save changes on the same page. | ||
| 17 | * Preview the result real-time and in place. See the page *before* submitting. | 17 | * Preview the result real-time and in place. See the page *before* submitting. | ||
| 18 | 18 | ||||
| n | 19 | **Search, Browse, Edit, Preview, and Submit from the same page!** | n | 19 | **Search, Browse, Edit, Preview, and Submit from the same page!** |
| 20 | 20 | ||||
| 21 | 21 | ||||
| 23 | ========================================= | 23 | ========================================= | ||
| 24 | 24 | ||||
| n | 25 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defi | n | 25 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defin |
| > | ne Pylowiki we must first define *Pylons* and *wiki*. | > | e Pylowiki we must first define *Pylons* and *wiki*. | ||
| 26 | 26 | ||||
| n | 27 | **def Pylons( pahy-lons ):** | n | 27 | **def Pylons( pahy-lons ):** |
| 28 | Pylons is a lightweight python web framework emphasizing flexibility and rapid | ||||
| > | development. | ||||
| 29 | |||||
| 30 | `. . . more about Pylons <http://pylonshq.com/>`_ | ||||
| 31 | 28 | ||||
| n | 32 | **def wiki( wik-ee ):** | n | 29 | Pylons is a lightweight python web framework emphasizing flexibility and rapid |
| > | development. | ||||
| 30 | |||||
| 31 | `. . . more about Pylons <http://pylonshq.com/>`_ | ||||
| 33 | 32 | ||||
| n | 34 | A collaborative website whose content can be edited by anyone who has access | n | 33 | **def wiki( wik-ee ):** |
| > | to it. | ||||
| 35 | 34 | ||||
| n | 36 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ | n | 35 | A collaborative website whose content can be edited by anyone who has access |
| > | to it. | ||||
| 37 | 36 | ||||
| n | 38 | **def Pylowiki( pahy - loh - wik-ee ):** | n | 37 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ |
| 39 | 38 | ||||
| n | n | 39 | **def Pylowiki( pahy - loh - wik-ee ):** | ||
| 40 | |||||
| 40 | A wiki built using the Pylons framework. | 41 | A wiki built using the Pylons framework. | ||
| 41 | 42 | ||||
| n | 42 | * Pylo wiki | n | 43 | * Pylo wiki |
| 43 | * Pile-O-wiki | 44 | * Pile-O-wiki | ||
| 44 | * Pile of wiki | 45 | * Pile of wiki | ||
| 45 | 46 | ||||
| 46 | 47 | ||||
| 47 | What mark-up does Pylowiki use? | 48 | What mark-up does Pylowiki use? | ||
| 48 | ===================================== | 49 | ===================================== | ||
| 49 | 50 | ||||
| n | 50 | Pylowiki uses `reStructured Text (reST) <http://docutils.sourceforge.net/docs/u | n | 51 | Pylowiki uses `reStructured Text (reST) <http://docutils.sourceforge.net/docs/us |
| > | ser/rst/quickref.html>`_ as its wiki mark-up. | > | er/rst/quickref.html>`_ as its wiki mark-up. | ||
| 51 | 52 | ||||
| 52 | How does Pylowiki render mark-up for real-time preview? | 53 | How does Pylowiki render mark-up for real-time preview? | ||
| 53 | ========================================================== | 54 | ========================================================== | ||
| n | 54 | Pylowiki uses ajax to send reST mark-up to the web server. The web server acce | n | 55 | Pylowiki uses ajax to send reST mark-up to the web server. The web server accep |
| > | pts reST and converts it to HTML. The HTML is sent back to the browser and appe | > | ts reST and converts it to HTML. The HTML is sent back to the browser and appea | ||
| > | ars on the page in place and in real-time! | > | rs on the page in place and in real-time! | ||
| 55 | 56 | ||||
| 56 | Why is real-time preview important? | 57 | Why is real-time preview important? | ||
| 57 | ```````````````````````````````````````````` | 58 | ```````````````````````````````````````````` | ||
| n | 58 | Real-time preview of the users wiki mark-up is important because of the followi | n | 59 | Real-time preview of the users wiki mark-up is important because of the followin |
| > | ng reasons: | > | g reasons: | ||
| 59 | 60 | ||||
| n | 60 | * Users get feedback before they save changes. | n | 61 | * Users get feedback before they save changes. |
| 61 | * Users do not have to leave the article to make a change, they may edit while | 62 | * Users do not have to leave the article to make a change, they may edit while t | ||
| > | the browse. | > | he browse. | ||
| 62 | * It is faster and leads to less consecutive edits by the same user. | 63 | * It is faster and leads to less consecutive edits by the same user. | ||
| 63 | * Its fun and futuristic! | 64 | * Its fun and futuristic! | ||
| 64 | 65 | ||||
| 65 | 66 | ||||
| 67 | ========================================== | 68 | ========================================== | ||
| 68 | 69 | ||||
| n | 69 | Thank you! Take a look at the `todo list </todo>`_ and see about implementing s | n | 70 | Thank you! Take a look at the `todo list </todo>`_ and see about implementing so |
| > | omething. | > | mething. | ||
| 70 | 71 | ||||
| n | 71 | You can also usability test, bug test, feature test Pylowiki. | n | 72 | You can also usability test, bug test, feature test Pylowiki. |
| 72 | 73 | ||||
| n | 73 | Bitbucket.org allows repository branching and merging. I will review all submi | n | 74 | Bitbucket.org allows repository branching and merging. I will review all submis |
| > | ssions and patches and intergrate into the main branch. | > | sions and patches and intergrate into the main branch. | ||
| 74 | 75 | ||||
| 75 | 76 | ||||
| 78 | ====================================== | 79 | ====================================== | ||
| 79 | 80 | ||||
| n | 80 | Yes, Pylowiki is opensourced. The hg mercurial repository is located at: | n | 81 | Yes, Pylowiki is opensourced. The hg mercurial repository is located at: |
| 81 | 82 | ||||
| t | 82 | * http://bitbucket.org/russellballestrini/pylowiki | t | 83 | * http://bitbucket.org/russellballestrini/pylowiki |
| 83 | 84 | ||||
| 84 | 85 | ||||
| rev 4 | rev 5 | ||||
|---|---|---|---|---|---|
| 64 | 64 | ||||
| 65 | 65 | ||||
| n | 66 | Where can I get the sourcecode? | n | ||
| 67 | ====================================== | ||||
| 68 | |||||
| 69 | Yes, Pylowiki is opensourced. The hg mercurial repository is located at: | ||||
| 70 | |||||
| 71 | * http://bitbucket.org/russellballestrini/pylowiki | ||||
| 72 | |||||
| 73 | |||||
| 74 | I'd like to help, what could I do? | 66 | I'd like to help, what could I do? | ||
| 75 | ========================================== | 67 | ========================================== | ||
| 82 | 74 | ||||
| 83 | 75 | ||||
| n | n | 76 | |||
| 77 | Where can I get the sourcecode? | ||||
| 78 | ====================================== | ||||
| 79 | |||||
| 80 | Yes, Pylowiki is opensourced. The hg mercurial repository is located at: | ||||
| 81 | |||||
| 82 | * http://bitbucket.org/russellballestrini/pylowiki | ||||
| 83 | |||||
| 84 | |||||
| 84 | Installation and Setup | 85 | Installation and Setup | ||
| 85 | ====================== | 86 | ====================== | ||
| 86 | 87 | ||||
| n | 87 | First you need to have a working pylons virtualenv. There are many ways to do | n | 88 | #. Setup a working pylons virtualenv, review the pylons wiki to get started. |
| 88 | this and the pylons wiki will get you started if you don't know how. | ||||
| 89 | 89 | ||||
| n | 90 | http://pylonshq.com/docs/en/1.0/gettingstarted/ | n | 90 | http://pylonshq.com/docs/en/1.0/gettingstarted/ |
| 91 | 91 | ||||
| n | 92 | example: | n | 92 | #. Acquire the Pylowiki source:: |
| 93 | |||||
| 94 | .. code-block:: bash | ||||
| 95 | |||||
| 96 | wget http://www.pylonshq.com/download/1.0/go-pylons.py | ||||
| 97 | python go-pylons.py --no-site-packages virtpy | ||||
| 98 | source virtpy/bin/activate | ||||
| 99 | |||||
| 100 | Next you need to get the ``Pylowiki`` source: | ||||
| 101 | |||||
| 102 | .. code-block:: bash | ||||
| 103 | 93 | ||||
| 104 | hg clone ssh://hg@bitbucket.org/russellballestrini/pylowiki | 94 | hg clone ssh://hg@bitbucket.org/russellballestrini/pylowiki | ||
| 105 | 95 | ||||
| n | 106 | Navigate to the ``pylowiki`` directory and create a config file as follows: | n | 96 | #. Navigate to the pylowiki directory and create a config file as follows:: |
| 107 | |||||
| 108 | .. code-block:: bash | ||||
| 109 | 97 | ||||
| 110 | paster make-config Pylowiki config.ini | 98 | paster make-config Pylowiki config.ini | ||
| 111 | 99 | ||||
| n | 112 | Tweak the config file as appropriate and then setup the application: | n | 100 | #. Tweak the config file as appropriate and then setup the application:: |
| 113 | |||||
| 114 | .. code-block:: bash | ||||
| 115 | 101 | ||||
| 116 | paster setup-app config.ini | 102 | paster setup-app config.ini | ||
| 117 | 103 | ||||
| n | 118 | Test the install by running the dev paste server: | n | 104 | #. Test the install by running the dev paste server:: |
| 119 | 105 | ||||
| n | 120 | .. code-block:: bash | n | 106 | paster serve --reload config.ini |
| 121 | 107 | ||||
| t | 122 | paster serve --reload config.ini | t | ||
| 123 | |||||
| 124 | Navigate a browser to http://127.0.0.1:5000 | 108 | #. Navigate a browser to http://127.0.0.1:5000 | ||
| 125 | |||||
| 126 | |||||
| 127 | |||||
| rev 3 | rev 4 | ||||
|---|---|---|---|---|---|
| 82 | 82 | ||||
| 83 | 83 | ||||
| n | n | 84 | Installation and Setup | ||
| 85 | ====================== | ||||
| 86 | |||||
| 87 | First you need to have a working pylons virtualenv. There are many ways to do | ||||
| 88 | this and the pylons wiki will get you started if you don't know how. | ||||
| 89 | |||||
| 90 | http://pylonshq.com/docs/en/1.0/gettingstarted/ | ||||
| 91 | |||||
| 92 | example: | ||||
| 93 | |||||
| 94 | .. code-block:: bash | ||||
| 95 | |||||
| 96 | wget http://www.pylonshq.com/download/1.0/go-pylons.py | ||||
| 97 | python go-pylons.py --no-site-packages virtpy | ||||
| 98 | source virtpy/bin/activate | ||||
| 99 | |||||
| 100 | Next you need to get the ``Pylowiki`` source: | ||||
| 101 | |||||
| 102 | .. code-block:: bash | ||||
| 103 | |||||
| 104 | hg clone ssh://hg@bitbucket.org/russellballestrini/pylowiki | ||||
| 105 | |||||
| 106 | Navigate to the ``pylowiki`` directory and create a config file as follows: | ||||
| 107 | |||||
| 108 | .. code-block:: bash | ||||
| 109 | |||||
| 110 | paster make-config Pylowiki config.ini | ||||
| 111 | |||||
| 112 | Tweak the config file as appropriate and then setup the application: | ||||
| 113 | |||||
| 114 | .. code-block:: bash | ||||
| 115 | |||||
| 116 | paster setup-app config.ini | ||||
| 117 | |||||
| 118 | Test the install by running the dev paste server: | ||||
| 119 | |||||
| 120 | .. code-block:: bash | ||||
| 121 | |||||
| 122 | paster serve --reload config.ini | ||||
| 123 | |||||
| 124 | Navigate a browser to http://127.0.0.1:5000 | ||||
| 84 | 125 | ||||
| 85 | 126 | ||||
| 86 | 127 | ||||
| t | 87 | t | |||
| rev 1 | rev 2 | ||||
|---|---|---|---|---|---|
| 79 | You can also usability test, bug test, feature test Pylowiki. | 79 | You can also usability test, bug test, feature test Pylowiki. | ||
| 80 | 80 | ||||
| n | n | 81 | Bitbucket.org allows repository branching and merging. I will review all submi | ||
| > | ssions and patches and intergrate into the main branch. | ||||
| 81 | 82 | ||||
| 82 | 83 | ||||
| 84 | 85 | ||||
| 85 | 86 | ||||
| t | t | 87 | |||
| empty | rev 1 | ||||
|---|---|---|---|---|---|
| t | t | 1 | About Pylowiki | ||
| 2 | ================== | ||||
| 3 | |||||
| 4 | .. contents:: Sections | ||||
| 5 | |||||
| 6 | |||||
| 7 | |||||
| 8 | Pylowiki's Primary Objective | ||||
| 9 | ============================= | ||||
| 10 | |||||
| 11 | The original goal of *Pylowiki* was to create an advanced same page, section ed | ||||
| > | it and preview, wiki solution. We succeeded! | ||||
| 12 | |||||
| 13 | Users are able to ... | ||||
| 14 | ````````````````````````` | ||||
| 15 | * Search, Browse, and View articles. | ||||
| 16 | * Edit and Save changes on the same page. | ||||
| 17 | * Preview the result real-time and in place. See the page *before* submitting. | ||||
| 18 | |||||
| 19 | **Search, Browse, Edit, Preview, and Submit from the same page!** | ||||
| 20 | |||||
| 21 | |||||
| 22 | What does the name Pylowiki mean? | ||||
| 23 | ========================================= | ||||
| 24 | |||||
| 25 | The name *Pylowiki* is a portmanteau of the words *Pylons* and *wiki*. To defi | ||||
| > | ne Pylowiki we must first define *Pylons* and *wiki*. | ||||
| 26 | |||||
| 27 | **def Pylons( pahy-lons ):** | ||||
| 28 | Pylons is a lightweight python web framework emphasizing flexibility and rapid | ||||
| > | development. | ||||
| 29 | |||||
| 30 | `. . . more about Pylons <http://pylonshq.com/>`_ | ||||
| 31 | |||||
| 32 | **def wiki( wik-ee ):** | ||||
| 33 | |||||
| 34 | A collaborative website whose content can be edited by anyone who has access | ||||
| > | to it. | ||||
| 35 | |||||
| 36 | `. . . more about wiki <http://en.wikipedia.org/wiki/Wiki>`_ | ||||
| 37 | |||||
| 38 | **def Pylowiki( pahy - loh - wik-ee ):** | ||||
| 39 | |||||
| 40 | A wiki built using the Pylons framework. | ||||
| 41 | |||||
| 42 | * Pylo wiki | ||||
| 43 | * Pile-O-wiki | ||||
| 44 | * Pile of wiki | ||||
| 45 | |||||
| 46 | |||||
| 47 | What mark-up does Pylowiki use? | ||||
| 48 | ===================================== | ||||
| 49 | |||||
| 50 | Pylowiki uses `reStructured Text (reST) <http://docutils.sourceforge.net/docs/u | ||||
| > | ser/rst/quickref.html>`_ as its wiki mark-up. | ||||
| 51 | |||||
| 52 | How does Pylowiki render mark-up for real-time preview? | ||||
| 53 | ========================================================== | ||||
| 54 | Pylowiki uses ajax to send reST mark-up to the web server. The web server acce | ||||
| > | pts reST and converts it to HTML. The HTML is sent back to the browser and appe | ||||
| > | ars on the page in place and in real-time! | ||||
| 55 | |||||
| 56 | Why is real-time preview important? | ||||
| 57 | ```````````````````````````````````````````` | ||||
| 58 | Real-time preview of the users wiki mark-up is important because of the followi | ||||
| > | ng reasons: | ||||
| 59 | |||||
| 60 | * Users get feedback before they save changes. | ||||
| 61 | * Users do not have to leave the article to make a change, they may edit while | ||||
| > | the browse. | ||||
| 62 | * It is faster and leads to less consecutive edits by the same user. | ||||
| 63 | * Its fun and futuristic! | ||||
| 64 | |||||
| 65 | |||||
| 66 | Where can I get the sourcecode? | ||||
| 67 | ====================================== | ||||
| 68 | |||||
| 69 | Yes, Pylowiki is opensourced. The hg mercurial repository is located at: | ||||
| 70 | |||||
| 71 | * http://bitbucket.org/russellballestrini/pylowiki | ||||
| 72 | |||||
| 73 | |||||
| 74 | I'd like to help, what could I do? | ||||
| 75 | ========================================== | ||||
| 76 | |||||
| 77 | Thank you! Take a look at the `todo list </todo>`_ and see about implementing s | ||||
| > | omething. | ||||
| 78 | |||||
| 79 | You can also usability test, bug test, feature test Pylowiki. | ||||
| 80 | |||||
| 81 | |||||
| 82 | |||||
| 83 | |||||
| 84 | |||||
| 85 | |||||
Remarkbox