Commit Graph

57 Commits

Author SHA1 Message Date
Uncle Cheese c71a1aaca2 These changes make a number of improvements, mostly typographical, to improve readability and to render properly on small devices.
Universal increase in font size
Use same font as ss.org for consistency
Remove unnecessary visual noise (borders, box shadows, etc)
Use Google PrettyPrint syntax highlighter for improved readability of code sections
Fully responsive, with hamburger menu
Add "section" linking mode to menu items
Add masthead for breadcrumbs, introduction
Improved styles for notice/info/warning messaging
2014-11-07 12:01:07 +13:00
Will Rossiter f169aa65ac Add support for exclude in children list 2014-10-13 21:55:16 +13:00
Will Rossiter cfa32d56e6 FIX: permission check broken 2014-09-28 17:10:55 +13:00
Will Rossiter 9cf55c57d7 Ensure manifest is cached between calls. 2014-09-27 10:12:54 +12:00
Will Rossiter 2612f221a6 Change DocumentationParser to use GFM for code 2014-09-26 20:15:40 +12:00
Will Rossiter 8057c9257c FIX Language viewer test. 2014-09-21 11:19:17 +12:00
Will Rossiter aed63c9df5 Fix issue with Language parameter not being set
When the user accesses a page more than three levels deep.
2014-09-20 13:43:22 +12:00
Will Rossiter 52733d6ebf Add support for [CHILDREN] shortcode
This allows you to build up dynamic listing pages much better.
2014-09-19 23:29:22 +12:00
Will Rossiter b489d5120a Fixes for unit tests with the latest manifest 2014-09-15 22:12:31 +12:00
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
Will Rossiter fab0cba8a8 Add bash syntax brush (Fixes #45) 2014-09-06 09:20:05 +12:00
Will Rossiter d68e523e72 Workaround search result matching. 2014-01-14 21:16:39 +13:00
Will Rossiter c8ba3ffd2a Fix 404 page not including requirements. 2014-01-11 16:20:53 +13:00
Ingo Schommer 032a49d929 3.1/3.2 compat 2013-03-26 11:16:46 +01:00
Sean Harvey 0350495d20 Fixing DocumentationViewer::handleAction() to work with SS 3.1 2013-02-20 10:05:05 +13:00
Sean Harvey 9cf85b0c19 If no versions registered for a module, don't show empty versions in template 2013-02-12 13:43:32 +13:00
Will Rossiter 389269936b Merge pull request #21 from Martimiz/search-20130107 2013-02-07 17:53:41 -08:00
Sean Harvey 4a1e5436eb BUG Fixing search not working when no specific versions of docs 2013-01-24 11:16:47 +13:00
Will Rossiter 73a66da658 Merge pull request #23 from sdiel/patch-1
Update code/controllers/DocumentationViewer.php
2013-01-11 13:53:43 -08:00
Sebastian Diel 5cc766583d Update code/controllers/DocumentationViewer.php
BUGFIX: fixed mechanism to get nested page entities when using upper case chars as the first char of a markdown files name or a folders name
2013-01-11 11:02:49 +01:00
Sebastian Diel 7d5ee2a249 Update code/controllers/DocumentationViewer.php
BUGFIX: fixed false variable name in DocumentationViewer::set_recursive_submenu()
2013-01-11 10:40:59 +01: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
martimiz 0bd844e139 Fix: no search results found on documentation homepage
On the homepage there are no searchedEntities nor searchedVersions
defined, so the searchForm creates empty hiddenfields. PerformSeach
creates subqueries for thes empty values resulting in the return of an
'Empty' query object.

Solution: do not create these fields when there are no entities/versions
2013-01-07 16:53:33 +01:00
martimiz 58d4f242b0 Fix: Search returns no results for auto-registered modules
Automatic registration sets the version to '' (empty). This breaks the
search as Lucene Search will return an Empty query object if a subquery
has an empty key.

Fix: register the modules as 'current' instead of ''. Setting the
version title to 'current' in DocumentViewer->getVersions() is now no
longer necessary.
2013-01-07 16:41:07 +01:00
martimiz 5d9feb3fe5 Fix: Search error on autoregistered entities
Error: [Warning] array_combine() [function.array-combine]: Both
parameters should have at least 1 element

HandleRequest for submitted forms returns before the automatic
registration of modules is performed, so no entities can be found.
Fixed by moving  DocumentationService::load_automatic_registration();
to the top of the function
2013-01-07 16:31:12 +01:00
Simon Welsh 6df20c1f73 Adds missing brace 2012-11-14 23:06:26 +13: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 27a4f91d70 Fix: missing 'current' linking mode in top-level menu
If there are no children, the LinkingMode was set to 'link' and never
to 'current'
2012-11-12 16:19:44 +01:00
Will Rossiter 9aaeadd7ff Migrated theme from doc.ss back to the module 2012-11-10 11:12:30 +13:00
martimiz 027b63ea0b FIX: remove version from the breadcrumb url for the stable version
Same as in the menu links. fixes multiple urls for the same content
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 317dbb1774 Method visibility 2012-11-10 09:27:10 +13:00
Will Rossiter 74b91a1dd1 NEW Yaml highlighting 2012-09-25 19:36:43 +12:00
Will Rossiter 4ffa1c71e6 FIX: prevent notice while doing search request. 2012-09-09 18:05:06 +12: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 ae092ebf19 BUGFIX: ensure E_STRICT compatibility with docsviewer and 3.0 handleRequest(). 2012-04-14 18:02:53 +12:00
Will Rossiter dd84574b8d BUGFIX: upgrade module to fit 3.0 api. 2012-04-14 17:00:22 +12:00
Will Rossiter 1e28e8252f MINOR: rename from docviewer to docsviewer 2012-04-08 21:36:16 +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 a12169c9e0 MINOR: include own syntax highlighting theme for ssdoc. 2011-08-11 13:32:09 +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 0ba6d8d338 Merge branch 'master' of github.com:silverstripe/silverstripe-sapphiredocs 2011-08-02 15:31:38 +12:00