doc:howto:faq

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
doc:howto:faq [2009/10/07 17:57] – added faq about external links philipdoc:howto:faq [2013/01/24 03:35] – :( philip
Line 58: 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: %%<entry>5.2.11, 5.3.1</entry>%%
 +
 +//How do I add markup for a configure option?//
 +  * Example: %%<option role="configure">--enable-debug</option>%%
 +
 +//When adding a <note>, should I add a <title>?//
 +  * Typically titles are useful for notes, but it's not required.
 +  * Syntax: %%<note><title>foo</title><para>note contents</para></note>%%
  
 //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 95: 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://doc.php.net/editor/+  * Demo: https://edit.php.net/ 
 + 
 +// How often is the documentation built? // 
 +  * Weekly on mirrors, several times daily on the doc server 
 +  * For specifics, see the [[doc:builds|doc builds]] article 
 + 
 +// 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/language-snippets.ent as an entity 
 +  * 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? Or undocumented (proto only) 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/configure.php 
 +phd --docbook doc-base/.manual.xml --package PHP --format php 
 +php doc-base/scripts/check-missing-docs.php -d output/index.sqlite 
 +</code> 
 +Undocumented documentation (skeletons exist, but only prototypes and basic information) can be found here: http://doc.php.net/php/undoc_functions.php 
 + 
 +// What .subversion/config settings should I have set? // 
 + 
 +<code> 
 +*.xml = svn:eol-style=native;svn:keywords=Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL 
 +</code>
doc/howto/faq.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1