Feature #27515

Render one particular manual

Added by Francois Suter almost 2 years ago. Updated almost 2 years ago.

Status:Resolved Start date:2011-06-17
Priority:Should have Due date:
Assignee:Francois Suter % Done:

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

Description

It would be very useful to be able to render a single manual. I propose to introduce both an "extension" and a "version" options to the CLI call so that a single extension can be targeted, or even just one version of a particular extension.

Note: I have already made this work locally with rough code, I will now prepare a proper patch.

issue27515.diff (8.8 kB) Francois Suter, 2011-06-17 16:30

issue27515-2.diff (9.5 kB) Francois Suter, 2011-06-17 17:01

Associated revisions

Revision 49246
Added by Francois Suter almost 2 years ago

Added the possibility to render manual for a single extension and a single version, resolves #27515

History

#1
Updated by Fabien Udriot almost 2 years ago

+1

#2
Updated by Francois Suter almost 2 years ago

Here's the patch, ready for testing :-)

Expanded CLI usage:

php typo3/cli_dispatch.phpsh ter_doc --extension=doc_core_tsref render

will render all versions of doc_core_tsref, but only handle doc_core_tsref

php typo3/cli_dispatch.phpsh ter_doc --extension=doc_core_tsref --version=4.5.0 render

will render only version 4.5.0 of doc_core_tsref.

#3
Updated by Francois Suter almost 2 years ago

Improved patch adds a counter for the number of rendered manuals and warns user if none were rendered (this might help spot input mistakes, like wrong extension key/version number combinations).

#4
Updated by Fabien Udriot almost 2 years ago

Tested successfully. Code is OK. Go ahead!

I wish we could split up the rendering process into smaller tasks if time allows it. For instance, when rendering only one extension, it does not make sense to run the taks bellow which slows down the rendering process.

* extensions.xml was modified since last run
* Deleting cached manual information from database
* Manual DB index was sucessfully reindexed
* FIXME: deleteOutDatedDocuments not implemented
* Checking for modified extension versions
* Found 21780 modified extension versions

If someone feels inspired to break it down into smaller unit, don't hesitate ;)

#5
Updated by Francois Suter almost 2 years ago

Thanks for the review. I agree that some parts should actually be skipped, but at least we now have the possibility to avoid rendering gazillions of manuals during each run.

#8
Updated by Francois Suter almost 2 years ago

  • Status changed from Accepted to Resolved
  • % Done changed from 0 to 100

Applied in changeset r49246.

Also available in: Atom PDF