| 7 | | 6 | |
|---|
| 8 | <py:def function="page_title">Guide to the Web Interface</py:def> | 7 | <py:def function="page_title">Guide to the Web Interface</py:def> |
|---|
| 9 | | 8 | |
|---|
| 10 | <div py:match="content"> | 9 | <div py:match="content"> |
|---|
| 11 | <h2>Guide to the Web Interface</h2> | 10 | <h2>Guide to the Web Interface</h2> |
|---|
| 12 | <p> | 11 | <p> |
|---|
| 13 | This page provides a guide to the features of the web interface. | 12 | This page provides a guide to the features of the web interface. |
|---|
| 14 | </p> | 13 | </p> |
|---|
| 15 | <h2> | 14 | <h2> |
|---|
| 16 | The Index | 15 | The Index |
|---|
| 17 | </h2> | 16 | </h2> |
|---|
| 18 | <p> | 17 | <p> |
|---|
| 19 | The <a href="${h.url_for(controller='text', action='index')}">text index | 18 | The <a href="${h.url_for(controller='text', action='index')}">text index |
|---|
| 20 | page</a> contains a list of all of the material on the system. | 19 | page</a> contains a list of all of the material on the system. |
|---|
| 21 | </p> | 20 | </p> |
|---|
| 22 | <h2> | 21 | <h2> |
|---|
| 23 | Viewing Works | 22 | Viewing Works |
|---|
| 24 | </h2> | 23 | </h2> |
|---|
| 25 | <p> | 24 | <p> |
|---|
| 26 | You can view works by clicking on the link available from the index page. | 25 | You can view works by clicking on the link available from the index page. |
|---|
| 27 | If you know the 'name/id' of a text you can view it directly by visiting the | 26 | If you know the 'name/id' of a text you can view it directly by visiting the |
|---|
| 28 | url: ${h.url_for(controller='text', action='view', id='name')} (you can work | 27 | url: ${h.url_for(controller='text', action='view', id='name')} (you can work |
|---|
| 29 | out id names by looking at the link urls on the index page). | 28 | out id names by looking at the link urls on the index page). |
|---|
| 30 | </p> | 29 | </p> |
|---|
| 31 | | 30 | |
|---|
| 32 | <h3>Viewing in different formats</h3> | 31 | <h3>Viewing in different formats</h3> |
|---|
| 33 | <p> | 32 | <p> |
|---|
| 34 | You can view a given text in a different format by setting the format | 33 | You can view a given text in a different format by setting the format |
|---|
| 35 | argument in the url query string like so: | 34 | argument in the url query string like so: |
|---|
| 36 | </p> | 35 | </p> |
|---|
| 37 | <pre> | 36 | <pre> |
|---|
| 38 | ${h.url_for(controller='text', action='view', id='name', format='format_name')} | 37 | ${h.url_for(controller='text', action='view', id='name', format='format_name')} |
|---|
| 39 | </pre> | 38 | </pre> |
|---|
| 40 | <p> | 39 | <p> |
|---|
| 41 | So to view the text with name id 'hamlet_gut' with line numbers shown you | 40 | So to view the text with name id 'hamlet_gut' with line numbers shown you |
|---|
| 42 | would visit (this link will only work if that text is indeed available on | 41 | would visit (this link will only work if that text is indeed available on |
|---|
| 43 | your system!): | 42 | your system!): |
|---|
| 44 | </p> | 43 | </p> |
|---|
| 45 | <blockquote><p> | 44 | <blockquote><p> |
|---|
| 46 | <a href="${h.url_for(controller='text', action='view', id='hamlet_gut', format='lineno')}"> | 45 | <a href="${h.url_for(controller='text', action='view', id='hamlet_gut', format='lineno')}"> |
|---|
| 47 | ${h.url_for(controller='text', action='view', id='hamlet_gut', format='lineno')}</a> | 46 | ${h.url_for(controller='text', action='view', id='hamlet_gut', format='lineno')}</a> |
|---|
| 48 | </p></blockquote> | 47 | </p></blockquote> |
|---|
| 49 | <p> | 48 | <p> |
|---|
| 50 | Available formats are: | 49 | Available formats are: |
|---|
| 51 | </p> | 50 | </p> |
|---|
| 52 | <ul> | 51 | <ul> |
|---|
| 53 | <li>format=plain - plain version of the file (default)</li> | 52 | <li>format=plain - plain version of the file (default)</li> |
|---|
| 54 | <li>format=raw - raw file returned as text/plain</li> | 53 | <li>format=raw - raw file returned as text/plain</li> |
|---|
| 55 | <li>format=lineno - text with line numbers added</li> | 54 | <li>format=lineno - text with line numbers added</li> |
|---|
| 56 | </ul> | 55 | </ul> |
|---|
| 57 | | 56 | |
|---|
| 58 | <h3>Multiviews</h3> | 57 | <h3>Multiviews</h3> |
|---|
| 59 | <p> | 58 | <p> |
|---|
| 60 | You can view mutiple texts at once by concatenating the name-ids | 59 | You can view mutiple texts at once by concatenating the name-ids |
|---|
| 61 | separated by '+'. For example to see the Gutenberg folio and non-folio | 60 | separated by '+'. For example to see the Gutenberg folio and non-folio |
|---|
| 62 | Othello side-by-side you would visit: <a | 61 | Othello side-by-side you would visit: <a |
|---|
| 63 | href="${h.url_for(controller='text', action='view', id=None, name='othello_gut_f othello_gut')}"> | 62 | href="${h.url_for(controller='text', action='view', id=None, name='othello_gut_f othello_gut')}"> |
|---|
| 64 | ${h.url_for(controller='text', action='view', id=None, name='othello_gut_f othello_gut')} | 63 | ${h.url_for(controller='text', action='view', id=None, name='othello_gut_f othello_gut')} |
|---|
| 65 | </a> | 64 | </a> |
|---|
| 66 | </p> | 65 | </p> |
|---|
| 67 | | 66 | |
|---|
| 68 | <h2> | 67 | <h2> |
|---|
| 69 | Search | 68 | Search |
|---|
| 70 | </h2> | 69 | </h2> |
|---|
| 71 | <p> | 70 | <p> |
|---|
| 72 | See the <a href="${h.url_for(controller='search', action='index')}">search section</a>. | 71 | See the <a href="${h.url_for(controller='search', action='index')}">search section</a>. |
|---|
| 73 | </p> | 72 | </p> |
|---|
| 74 | | 73 | |
|---|
| 75 | <h2> | 74 | <h2> |
|---|
| 76 | Stats | 75 | Stats |
|---|
| 77 | </h2> | 76 | </h2> |
|---|
| 78 | <p> | 77 | <p> |
|---|
| 79 | See the <a href="${h.url_for(controller='stats', action='index')}">stats section</a>. | 78 | See the <a href="${h.url_for(controller='stats', action='index')}">stats section</a>. |
|---|
| 80 | </p> | 79 | </p> |
|---|
| 81 | | 80 | |
|---|
| 82 | | 81 | |
|---|
| 83 | <h2>Comments</h2> | 82 | <h2>Comments</h2> |
|---|
| 84 | <p> | 83 | <p> |
|---|
| 85 | If you wish to comment on this guide (or help improve it!) please drop a | 84 | If you wish to comment on this guide (or help improve it!) please drop a |
|---|
| 86 | line to the Open Shakespeare team via at info [at] okfn [dot] org. | 85 | line to the Open Shakespeare team via at info [at] okfn [dot] org. |
|---|
| 87 | </p> | 86 | </p> |
|---|
| 88 | </div> | 87 | </div> |
|---|
| 89 | | 88 | |
|---|
| 90 | <xi:include href="layout.html" /> | 89 | <xi:include href="layout.html" /> |
|---|