Commit Graph

48 Commits

Author SHA1 Message Date
Will Rossiter
1e04aaed28 Fix breadcrumbs 2014-09-07 22:14:10 +12:00
Will Rossiter
314e504903 Show nested sidebar menu 2014-09-07 21:28:21 +12:00
Will Rossiter
31a3b8a744 Add an alphabetical index (Fixes #5) 2014-09-07 20:35:08 +12:00
Will Rossiter
0b91b91e33 Kill DocumentationService in favour of config API.
This continues on the migration to the Manifest. Instead of using calls to a `Service` now all file related lookups are done through the `DocumentationManifest`
2014-09-07 17:09:28 +12:00
Will Rossiter
43b6d42719 Overhaul of module to use DocumentationManifest
This major update changes the behaviour of the docviewer module to use a cached manifest rather than on demand. This allows us to simplify the URL matching and store 'nice' URL configuration rather than altering handleAction().
2014-09-07 11:26:12 +12:00
Will Rossiter
e80edc445e Move advanced form out to it's own class
Make page title customizable through the Config system (Fixes #44)
2014-09-06 11:22:05 +12:00
Will Rossiter
2c00a3b20f New theme.
Clean up of existing theme, implementation of a new easier to integrate layout.
2014-09-06 11:13:12 +12:00
Sam Minnee
b6b753ee4c FIX: Fixed encoding of & in OpenSearchDescription URLs.
Without this fix, the & was then passed to urlencode(), which escaped the ; and make invalid
XML.  This keeps XML out of the source URL (so the & is just a raw & in the code) and relies on
the template engine to escape XML as needed (the .XML on the end of the variables).
2014-02-14 09:38:37 +13:00
Ingo Schommer
5a742b8584 Note about requiring github.com login for "edit this page"
See https://github.com/silverstripe/doc.silverstripe.org/issues/6
2013-10-30 23:07:38 +01:00
Ingo Schommer
032a49d929 3.1/3.2 compat 2013-03-26 11:16:46 +01:00
Will Rossiter
389269936b Merge pull request #21 from Martimiz/search-20130107 2013-02-07 17:53:41 -08:00
Sean Harvey
6eca5af929 Improve default template of DocumentationViewer
class "container" was missing, so a bunch of CSS wasn't being applied.
The layout of the default docsviewer checkout now looks more like the
one on doc.silverstripe.org.
2013-01-24 10:02:18 +13:00
martimiz
9f1f70a065 Enhancement: allow for enabling/disabling advanced search
The advanced searchbox only really functions properly for multiple
entities if they all have similar versions. If not, it will let you
search on entity-version combinations that might not even exist, which
can get confusing..

In such cases optionally disabling it could be a solution, waiting for
a better solution (possibly
2013-01-07 17:26:39 +01:00
Will Rossiter
0eadf2d174 Merge pull request #20 from Martimiz/master-update-121112
Styling 404 and selecting toplevel pages without children
2012-11-12 21:05:55 -08:00
martimiz
3dcf210045 changed getSubmenu to getSubmenuLocation
Because it doen't return the submenu itself, it returns the preferred
location
2012-11-13 18:04:05 +13:00
martimiz
0df804f86c Allow for either nested or separate submenu form template. Include recursive option
Default setting: separate submenu, no recursion.

Setting recursion fetches all children, to allow for JavaScript-powered
submenus (script not included). If recursion is enabled, separate menus
are disabled.
2012-11-13 18:04:05 +13:00
martimiz
f2b643871e Fix: provide styling for 404 pages 2012-11-12 16:24:55 +01:00
Will Rossiter
9aaeadd7ff Migrated theme from doc.ss back to the module 2012-11-10 11:12:30 +13:00
martimiz
581062b412 Move the nested submenu to a separate block using JavaScript 2012-11-10 09:27:27 +13:00
martimiz
7e7b67548e Mark submenu items with children as folders
Add an arrow to submenuitems that have undelying pages
2012-11-10 09:27:27 +13:00
martimiz
5a29f0c9ba Relocate table of contents
The table of contents is removed from the sidebar and relocated
underneath breadcrumbs and page title (if there is one). It can be
toggled open and closed.
2012-11-10 09:27:27 +13:00
martimiz
62dd4e92f7 Relocate breadcrumbs to the top of the document
Remove breadcrumbs from the searchbar to the top of the page content,
and make sure they only display if there is more then the current link.
Wrap the module and version selectors to fill the gap in the searchbar.
2012-11-10 09:27:27 +13:00
Will Rossiter
3a9a384ca4 NEW: Add set_edit_link() and getEditLink() to DocumentViewer to allow adding edit links to be displayed on documentation pages 2012-09-03 22:02:42 +12:00
Will Rossiter
34d46b7a5b MINOR: update references to sapphiredocs to docviewer. ENHANCEMENT: introduce DOCVIEWER_PATH and DOCVIEWER_DIR consts 2012-04-08 21:23:49 +12:00
Will Rossiter
7381733b4c BUGFIX: fixed search index field naming from module to entity to be consistent. BUGFIX: fixed url for opensearch description. ENHANCEMENT: moved author information to meta_data 2011-08-11 17:03:42 +12:00
Will Rossiter
85e5b1b72d FEATURE: added advanced search form to allow searching by module and version 2011-08-04 10:04:53 +12:00
Will Rossiter
56578742f4 MINOR: merging changes from ss2doc back. APICHANGE: renamed DocumentationOpenSearch_Controller to DocumentationOpenSearchController. MINOR: renamed left and right column to more generic content/sidebar columns 2011-08-02 15:30:58 +12:00
Will Rossiter
035df99088 BUGFIX: fixed reference to incorrect method from homepage. (Hat tip to nyeholt) 2011-07-25 16:14:43 +12:00
Will Rossiter
959cb16534 FEATURE: added automatic notifications about accessing outdated or unreleased versions. (Fixes #6320) 2011-07-08 14:42:52 +12:00
Will Rossiter
96ac20a15c BUGFIX: fixed bug with linking to internal assets. 2011-07-04 16:58:15 +12:00
Will Rossiter
762eb2323b APICHANGE: Renamed internal references of modules to entities and related method naming. FEATURE: added entity navigation in header. BUGFIX: fixed version links so that they redirect to the version of the current page rather than home page 2011-07-01 18:49:31 +12:00
Will Rossiter
4830e09bad ENHANCEMENT: moved 404 page out to a separate template and altered DocumentationViewer to throw 404s on pages which do not resolve to anything. Fixes: #6616 2011-07-01 14:37:55 +12:00
Will Rossiter
15244a9934 ENHANCEMENT: rolled out basic versioning support. 2011-07-01 13:19:35 +12:00
Will Rossiter
aa0297d52a Cherry picked changes from doc.silverstripe.org. FEATURE: added boost options to promoting or removing listings from the search. ENHANCEMENT: use a breadcrumb trail for search title to provide additional context 2011-04-29 14:41:30 +12:00
Will Rossiter
cfaa08d858 ENHANCEMENT: fixed default homepage template to include links to individual modules rather than blank pages. BUGFIX: fixed doc viewer to not throw 404 error when no module provided 2011-03-12 17:14:37 +13:00
Will Rossiter
50de5f23ef MINOR: removed link to ssdocs project from module. 2011-03-12 17:12:48 +13:00
Will Rossiter
0ec206eff5 MINOR: changed opensearch output to atom rather than rss 2011-02-25 11:32:17 +13:00
Will Rossiter
13fdb8dd80 APICHANGE: refactored DocumentationSearch to go back to a simple class rather than a controller. All requests interfacing with the search should go through DocumentationViewer. APICHANGE: migrated DocumentationSearch::opensearch() to its own controller. BUGFIX: declare default meta_data in the function rather than using the api to prevent inclusion order issues 2011-02-11 01:29:25 +00:00
Will Rossiter
166fb8dff3 FEATURE: implemented initial cut of open search output and description functionality. 2011-01-21 04:10:41 +00:00
Ingo Schommer
5d48bc97de BUGFIX Fixed 404 display 2011-01-16 20:17:57 +00:00
Will Rossiter
768345a8b9 ENHANCEMENT: contrary to r115556, display a listing of files within an empty folder index rather than defaulting to the first file. Fixes #6347 2011-01-14 02:16:03 +00:00
Will Rossiter
8ba0bcea69 BUGFIX: fixed pagination of search results not loading on pages other than the first 2010-12-22 08:44:46 +00:00
Will Rossiter
842043a8e3 ENHANCEMENT: cleaned up logic around Link() and Path() attributes throughout. FEATURE: added search pagination and rough templates for the search results 2010-12-22 08:21:49 +00:00
Will Rossiter
3d90271b31 FEATURE: initial cut of Zend_Lucene_Search backend for documentation search. 2010-12-21 09:42:44 +00:00
Will Rossiter
ef7c095533 FEATURE: allow 3 levels of navigation for the module. _getModulePages() should in theory support any depth of pages 2010-10-22 03:46:44 +00:00
Ingo Schommer
df4a3ed721 MINOR Removed debug code 2010-08-01 04:46:28 +00:00
Will Rossiter
a07855109f FEATURE: added support to register versions and modules manually and disable the automatic includsion. FEATURE: added support for multiple versions and languages in the documentation. ENHANCEMENT: added toolbox to view module docs on pages and lots of other new templates 2010-06-24 14:22:41 +00:00
Will Rossiter
dddf71efe6 ENHANCEMENT: coverted sapphiredocs to use SSViewer instead of DevelopmentAdmin templating. BUGFIX: fixed anchors generated in the table of contents. 2010-04-11 07:25:26 +00:00