Will Rossiter
1e28e8252f
MINOR: rename from docviewer to docsviewer
2012-04-08 21:36:16 +12:00
Will Rossiter
a87094fb16
BUGFIX: check for valid directory before opening
2012-04-08 21:27:53 +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
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
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
Marcus Nyeholt
c9f35cebbb
BUGFIX: Changed the base URL for the search so it hits the correct action
2011-07-25 14:35:11 +10:00
Marcus Nyeholt
99951426ed
BUGFIX: Change the doc folder search to use the correct folder name variable.
...
BUGFIX: Use the full path to the basefolder when searching for folders; cwd is actually sapphire, so this ends up looking in the wrong path otherwise
2011-07-25 14:34:30 +10: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
cb19549a97
ENHANCEMENT: if viewing site on current version, do not include version in the parsed links
2011-07-04 12:05:22 +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
ef5664f777
BUGFIX: fixed encoding of special characters when not in code snippets.
2011-04-05 14:17:25 +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
bbc657acfc
MINOR: changed theme to a darker one to help with readability
2011-03-07 09:55:29 +13:00
Will Rossiter
ac608190c6
MINOR: update links to use atom rather than RSS
2011-02-25 11:53:17 +13:00
Will Rossiter
bb35223fea
MINOR: changed pipe to dash. Easier on the eyes.
2011-02-25 09:22:36 +13:00
Ingo Schommer
b1c93bd27a
BUGFIX Allowing 'trunk' and 'master' as version numbers
2011-02-24 17:54:44 +13:00
Will Rossiter
94121f0a66
BUGFIX: fixed link to search query from opensearch description
2011-02-11 15:28:26 +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
24ebc64945
BUGFIX Showing proper 404s
2011-01-17 06:00:16 +00:00
Ingo Schommer
b61e4e9057
BUGFIX Absolute include paths so phpunit executable doesnt barf
2011-01-17 06:00:16 +00:00
Ingo Schommer
5d48bc97de
BUGFIX Fixed 404 display
2011-01-16 20:17:57 +00:00
Ingo Schommer
e024be8806
BUGFIX Fixed relative and absolute links
2011-01-16 20:17:56 +00:00
Ingo Schommer
089c844892
MINOR Making anchors more readable and predictable by using lowercase only
2011-01-15 21:47:43 +00:00
Will Rossiter
e571b5973f
FEATURE: added parser for metadata inside documentation. MINOR: removed outdated code
2011-01-14 03:29:14 +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
2a7b7ee83d
ENHANCEMENT: if a folder is missing an index.md file load the first file as a failback
2011-01-14 01:48:36 +00:00
Will Rossiter
fc8ab96c51
ENHANCEMENT: use urls in the format module/lang/version rather than version first. Tweaks to the parser to prevent infinite loops
2011-01-14 01:03:46 +00:00
Will Rossiter
24f1b13233
FEATURE: added $PageTitle output for nicer bookmarked urls
2011-01-13 20:34:55 +00:00
Will Rossiter
9bd43ae7ad
BUGFIX: only strip off dot and trailing string if it is a possible extension
2011-01-13 08:34:33 +00:00
Ingo Schommer
160b527dfc
BUGFIX Fixed DocumentationViewer->_getModulePagesNested(), wasn't comparing anything lower than first level properly
2011-01-13 08:27:27 +00:00
Ingo Schommer
ac5b0e53e8
MINOR Documentation
2011-01-13 08:27:26 +00:00
Ingo Schommer
e0c8b6e9e0
BUGFIX Added DocumentationPage->getRelativeLink(), which opposing to getRelativePath() excludes the extension
2011-01-13 08:27:25 +00:00
Ingo Schommer
652f7c3898
BUGFIX Fixed anchor parsing in headlines ( fixes #6342 )
2011-01-13 07:20:55 +00:00
Ingo Schommer
8e69d51af7
MINOR Fixed syntaxhighlighter brush paths
2011-01-11 19:44:56 +00:00
Will Rossiter
221cd700b6
ENHANCEMENT: included zend/search/lucene with the module to avoid including the entire lucene module. ENHANCEMENT: added hourly task as well as buildtask for dealing with cron updates. MINOR: updated documentation
2011-01-11 01:35:59 +00:00
Ingo Schommer
59c9762dc0
MINOR Changed syntax highlighting theme to a lighter one
2011-01-10 11:36:23 +00:00
Ingo Schommer
f9a2306875
MINOR Added CSS brush to syntax highlighting includes
2011-01-10 11:36:22 +00:00
Ingo Schommer
2c67fb7650
ENHANCEMENT Added custom "SS" brush for syntax highlighting (needs work)
2011-01-10 11:36:21 +00:00
Ingo Schommer
135415c2e3
MINOR Enabled markdown code block parsing logic, README for syntax highlighting, loading syntaxhighlighter JS and CSS
2011-01-10 10:59:31 +00:00
Ingo Schommer
255f5de162
BUGFIX Improved DocumentationParser to avoid empty lines in pre tags, deal with normal markdown code blocks, and html encode lines within pre tags
2011-01-10 10:59:22 +00:00
Ingo Schommer
4abf31e8d0
MINOR Moved markdown.php into thirdparty/markdown/
2011-01-10 10:59:20 +00:00
Ingo Schommer
b7478b864d
FEATURE <pre> formatting for markdown with custom brush support (:::php to <pre class="brush: php">)
2011-01-10 09:18:44 +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
fede2626fc
MINOR: moved building indexes out to its own tasks.
2010-12-21 10:54:11 +00:00
Will Rossiter
b51421d964
BUGFIX: avoid parsing the markdown to html of each page to index it, simply use plain text for search. BUGFIX: disable notice level errors from Zend when building the index
2010-12-21 10:05:24 +00:00
Will Rossiter
7ec4ae32ad
MINOR: removed var_dumps()
2010-12-21 09:44:37 +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
30b5134b80
BUGFIX: use sapphire as the default location. BUGFIX: fixed index templates being thrown as 404
2010-10-29 02:24:58 +00:00
Will Rossiter
9335c789af
ENHANCEMENT: hide index pages from menus. BUGFIX: fixed incorrect name strings coming through on nested pages
2010-10-29 02:12:20 +00:00
Will Rossiter
8a02cee714
BUGFIX: only strip the last most extension off, rather than from the start.
2010-10-29 01:39:45 +00:00
Will Rossiter
587f557949
BUGFIX: fixed url in header anchors. Added missing js link in the controller
2010-10-28 21:27:30 +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
Will Rossiter
1a5c88b469
MINOR: updated documentation for permalinks
2010-10-22 02:09:15 +00:00
Will Rossiter
7546e9429a
BUGFIX: fixed homepage storing current as module
2010-10-22 01:52:35 +00:00
Will Rossiter
8937d56547
APICHANGE: refactored names and structure of handleAction rerouting to a) be more clearer and b) to allow permalinks
2010-10-22 01:10:04 +00:00
Will Rossiter
0be89228e7
BUGFIX: catch any errors thrown by incorrect paths nicer
2010-10-22 01:08:44 +00:00
Will Rossiter
354aa95e2b
FEATURE: added ability to define a set of shortcodes or permalinks which translate to full paths
2010-10-22 01:07:49 +00:00
Will Rossiter
d2eb92233e
APICHANGE: rather than passing the structure through the constructor, do so via setters which will allow us more flexibility
2010-10-21 20:27:23 +00:00
Will Rossiter
ac5ce3872e
EHANCEMENT allow recursive gathering of files from a folder. Initial cut of implementing a XML feed of all the pages
2010-10-08 03:31:19 +00:00
Saophalkun Ponlu
6ba14bed75
BUGFIX: Resolve navigation sorting using natural sort
2010-09-05 02:29:07 +00:00
Saophalkun Ponlu
257c833e86
ENHANCEMENT: Automatic (and manual) hash link generation for headlines done in server-side
2010-09-03 05:29:15 +00:00
Ingo Schommer
e6a88699ce
MINOR Throwing exception when path is not found
2010-09-03 01:37:51 +00:00
Ingo Schommer
3c3e57fec3
MINOR Documentation
2010-09-03 01:37:51 +00:00
Ingo Schommer
1e7c8aefe4
MINOR Fixed commenting
2010-08-01 21:14:41 +00:00
Ingo Schommer
7516d31ce0
ENHANCEMENT Started code block parser (still needs work)
2010-08-01 21:13:40 +00:00
Ingo Schommer
e1da17e9d9
FEATURE Rewrite image links
...
ENHANCEMENT Return string from parser (instead of HTMLText dependency)
2010-08-01 08:25:00 +00:00
Ingo Schommer
845e2e61b2
ENHANCEMENT Rewriting current version URL path to 'current/'
2010-08-01 07:03:52 +00:00
Ingo Schommer
f623dcc887
MINOR Fixed path concat issues
2010-08-01 07:03:50 +00:00
Ingo Schommer
a013923106
ENHANCEMENT Added setCurrentVersion()
2010-08-01 07:03:48 +00:00
Ingo Schommer
281e6e1ea7
ENHANCEMENT Make permission checks configurable
2010-08-01 05:04:36 +00:00
Ingo Schommer
591b87e939
BUGFIX Allow using module on root URL space
2010-08-01 04:46:41 +00:00
Ingo Schommer
b8cdec0531
BUGFIX Fixed <code> formatting for api links
2010-08-01 04:46:39 +00:00
Ingo Schommer
b96b2b4016
FEATURE Parsing of API links
2010-08-01 04:46:37 +00:00
Ingo Schommer
277bca7b11
FEATURE Added parsing support for relative links (relative to module base). Introduced DocumentationPage to encapsulate this information.
...
ENHANCEMENT Saving $ModuleName in viewer instead of getting it from Remaining[0]
MINOR Don't include version in breadcrumbs, doesn't make sense in this context (e.g. "2.4/en/cms", the "2.4" part is connecte to the cms module, hence an index of all versions regardless of module is not very useful)
2010-08-01 04:46:32 +00:00
Ingo Schommer
c61635be80
ENHANCEMENT Excluding _images folders automatically
2010-08-01 04:46:26 +00:00
Ingo Schommer
8f2a9375b9
BUGFIX Fixed $module variable reference in unregister()
2010-08-01 04:46:24 +00:00
Will Rossiter
3a94574ef6
BUGFIX: changed $request to not return a null spaced array. Updated docs to reflect that
2010-06-26 04:49:20 +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
e11837763b
MINOR: added space between commas to allow line breaks
2010-06-03 03:02:44 +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
Will Rossiter
22549a2ab1
APICHANGE: upon the popular vote /docs/ for documentation rather than /doc/
2010-04-11 04:02:25 +00:00
Will Rossiter
aa2c0cadc3
BUGFIX: fixed path to jquery and incorrect file path location
2010-03-26 02:50:30 +00:00
Will Rossiter
f78967a69d
ENHANCEMENT: moved away from DebugView display / layout
2010-03-04 10:18:02 +00:00
Will Rossiter
ee8eb4e7b5
MINOR: changed path for docs from docs to doc
2010-03-04 08:54:17 +00:00
Will Rossiter
ae6e8ee3d4
BUGFIX: removed DebugView requirement.
2010-03-04 05:00:13 +00:00
Will Rossiter
3a1a16a51e
BUGFIX: removed DebugView requirement.
2010-03-04 04:59:00 +00:00
Will Rossiter
f160bff8b3
FEATURE: initial commit of sapphire documentation viewer module. Parses each module with a docs folder and generates formatted trees for each. Parses single markdown files for display
2010-03-04 04:39:02 +00:00