doc:howto:faq
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
doc:howto:faq [2009/09/25 16:33] – added manual.xml.in entry philip | doc:howto:faq [2013/01/24 03:35] – :( philip | ||
---|---|---|---|
Line 8: | Line 8: | ||
* Use %%< | * Use %%< | ||
* Note that the case does not matter when adding a link. | * Note that the case does not matter when adding a link. | ||
+ | |||
+ | //How do I add an external link to the documentation?// | ||
+ | * All external links are added to doc-base/ | ||
+ | * Add the link there (to global.ent) | ||
+ | * The global.ent markup might look like: %%< | ||
+ | * Add the link to the documentation (foo.xml) | ||
+ | * The markup might look like: %%<link xlink: | ||
+ | * Be sure the file understands the namespace with %%xmlns: | ||
+ | |||
+ | //I made a change to a file but want to revert this change, how?// | ||
+ | * To merge a file to the previous state: svn merge -rHEAD:PREV filename.xml | ||
+ | * Then, to commit it: svn commit filename.xml -m " | ||
//I'm about to document a new PHP extension... how should I start?// | //I'm about to document a new PHP extension... how should I start?// | ||
Line 14: | Line 26: | ||
* Example: $ php docgen.php -e simplexml -o outdir | * Example: $ php docgen.php -e simplexml -o outdir | ||
* It creates the skeletons that you edit then commit | * It creates the skeletons that you edit then commit | ||
+ | |||
+ | //I created skeletons that contain a bunch of default text, should I commit it?// | ||
+ | * No, edit the files before commit. | ||
+ | * Reason 1: Translators | ||
+ | * Reason 2: Temporary often becomes permanent, and bogus text is not good | ||
//I documented an extension but it's not building. Why?// | //I documented an extension but it's not building. Why?// | ||
Line 41: | Line 58: | ||
//In the changelog, which order do the PHP versions go?// | //In the changelog, which order do the PHP versions go?// | ||
* Newest PHP versions go above the older ones | * Newest PHP versions go above the older ones | ||
+ | |||
+ | //In the changelog, a change happened in two PHP versions. How do I enter this?// | ||
+ | * Multiple versions are separated by a comma, with the lesser version first. Example: %%< | ||
+ | |||
+ | //How do I add markup for a configure option?// | ||
+ | * Example: %%< | ||
+ | |||
+ | //When adding a < | ||
+ | * Typically titles are useful for notes, but it's not required. | ||
+ | * Syntax: %%< | ||
//A feature became available in PHP X.Y.Z, how do I document that?// | //A feature became available in PHP X.Y.Z, how do I document that?// | ||
Line 78: | Line 105: | ||
* Yes one exists in SVN and is being worked on. | * Yes one exists in SVN and is being worked on. | ||
* No it's not yet in use. | * No it's not yet in use. | ||
- | * Demo: http:// | + | * Demo: https:// |
+ | |||
+ | // How often is the documentation built? // | ||
+ | * Weekly on mirrors, several times daily on the doc server | ||
+ | * For specifics, see the [[doc: | ||
+ | |||
+ | // I see example.outputs and example.outputs.similar entities, what's the difference? // | ||
+ | * The example.outputs.similar entity is used when the output may differ between executions or machines | ||
+ | * The example.outputs entity output will always, under all conditions, be the same | ||
+ | |||
+ | // I need to add a piece of text to three or more pages, how? // | ||
+ | * Add the snippet to en/ | ||
+ | * Link to the entity within the desired pages | ||
+ | * This is done so translators can update one version of this text | ||
+ | |||
+ | // How do I find missing documentation? | ||
+ | |||
+ | Missing functions (no associated XML files) can be found like so (assuming a doc checkout, and PhD is installed): | ||
+ | <code shell> | ||
+ | php doc-base/ | ||
+ | phd --docbook doc-base/ | ||
+ | php doc-base/ | ||
+ | </ | ||
+ | Undocumented documentation (skeletons exist, but only prototypes and basic information) can be found here: http:// | ||
+ | |||
+ | // What .subversion/ | ||
+ | |||
+ | < | ||
+ | *.xml = svn: | ||
+ | </code> |
doc/howto/faq.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1