Bug #30446

Add support for a different path to the documentation

Added by Chris topher over 1 year ago. Updated over 1 year ago.

Status:New Start date:2011-09-29
Priority:Should have Due date:
Assignee:- % Done:

0%
Category:- Spent time: -
Target version:-
Votes: 0

Description

The new Extension Manager offers support for a custom documentation path. Inside ext_emconf.php you can us the key docPath to point to your manual. The manual then no longer has to be in the folder doc/, but can be in any subfolder.

Here is the code:
1 $manual = $path . $extKey . '/' . $list[$key]['docPath'] . '/manual.sxw';

ter_fe should respect that option too, when it displays links to the manual.

History

#1
Updated by Georg Ringer over 1 year ago

especially needed with extbase based extensions

#2
Updated by Kai Vogel over 1 year ago

  • Status changed from New to Rejected

Since the ter_fe extension gets the online documentation link without subsequent manipulation directly from the ter_doc extension, this is a ter_doc ticket. Direct links to the sxw manual are not implemented or planned.

require_once(t3lib_extMgm::extPath('ter_doc') . 'class.tx_terdoc_api.php');
$terDocApi = tx_terdoc_api::getInstance();
$link = $terDocApi->getDocumentationLink($extensionKey, $versionString);

#3
Updated by Jigal van Hemert over 1 year ago

Instead of rejecting it, please move it to the ter_doc bugtracker.

The problem is in tx_terdoc_renderdocuments::documentCache_transformManualToDocBook() where the path to the documentation is hardcoded.

if (!$this->t3x_extractFileFromT3X ($extensionKey, $version, 'ext_emconf.php', $errorCodes, PATH_site . 'typo3temp/ext_emconf.php')) {
  $this->log ('    * documentCache_transformManualToDocBook: problem while extracting ext_emconf.php from t3x file');
  return FALSE;
}
$_EXTKEY = $extensionKey;
  // scope for the include is local to this function, so no chance of overwriting anything important
@include_once(t3lib_div::getUrl(PATH_site . 'typo3temp/ext_emconf.php');
  // clean up the temp file
@unlink(PATH_site . 'typo3temp/ext_emconf.php');
$documentationPath = isset($EM_CONF[$extensionKey]['docPath']) ? $EM_CONF[$extensionKey]['docPath'] : 'doc';

if (!$this->t3x_extractFileFromT3X ($extensionKey, $version, $documentationPath . '/manual.sxw', $errorCodes, $documentDir.'manual.sxw')) {

#4
Updated by Jigal van Hemert over 1 year ago

  • Tracker changed from Task to Bug
  • Project changed from TER Frontend Index to ter_doc
  • Status changed from Rejected to New
  • Priority changed from Must have to Should have

Also available in: Atom PDF