doc:howto:faq
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:howto:faq [2009/09/09 01:06] – misc update philip | doc:howto:faq [2017/09/22 13:28] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ===== Questions related to writing documentation ===== | + | This page has been removed, in favor of [[http:// |
- | + | ||
- | //If a < | + | |
- | * Add the **role=" | + | |
- | * Example: %%< | + | |
- | + | ||
- | //How do I add a link to a method?// | + | |
- | * Use %%< | + | |
- | * Note that the case does not matter when adding a link. | + | |
- | + | ||
- | //I'm about to document a new PHP extension... how should I start?// | + | |
- | * Use the script found within phpdoc/ | + | |
- | * Example: $ php docgen.php -h | + | |
- | * Example: $ php docgen.php -e simplexml -o outdir | + | |
- | * It creates the skeletons that you edit then commit | + | |
- | + | ||
- | //I want to contribute to the PHP Manual, how?// | + | |
- | * First, read the [[doc: | + | |
- | * Check out the sources: $ svn checkout http:// | + | |
- | * For a translation, | + | |
- | * ... | + | |
- | + | ||
- | //How do I build and/or test the manual locally?// | + | |
- | * Use phpdoc/ | + | |
- | * To validate en: **$ php configure.php** | + | |
- | * To validate fr: **$ php configure.php %%--with-lang=fr%%** (Change fr to your given language code) | + | |
- | * To build: **$ phd -d .manual.xml** | + | |
- | * Note: Building is not required, all you must do is check the diff and be sure it validates | + | |
- | + | ||
- | //Running configure.php ends up Segfaulting, | + | |
- | * There are bugs with certain versions of libxml that cause this, so hacks exist to get around it | + | |
- | * To execute the hack, pass in: **$ php configure.php %%--disable-segfault-error%%** | + | |
- | * Note: This disables some error checking and beautification but raw errors will be shown | + | |
- | * Note: Usually the problem is a major XML syntax issue | + | |
- | + | ||
- | //In the changelog, which order do the PHP versions go?// | + | |
- | * Newest PHP versions go above the older ones | + | |
- | + | ||
- | //A feature became available in PHP X.Y.Z, how do I document that?// | + | |
- | * Version information for functions is stored inside **versions.xml** within each extension: phpdoc/ | + | |
- | * Changes to functions, like added parameters, are documented within changelogs for each page | + | |
- | * Example Text: Feature X has been available since PHP X.Y.Z | + | |
- | * TODO: Research other ways, and the best way, to write this text (including dealing with code examples) | + | |
- | + | ||
- | //Why does everyone care so much about whitespace?// | + | |
- | * See the following article: | + | |
- | * XML is one space, PHP example code is four, and max width is ~78 characters | + | |
- | * Exceptions: < | + | |
- | + | ||
- | //A parameter is optional, how is it documented?// | + | |
- | * Like normal, except methodparam receives the choice=" | + | |
- | * Example: %%< | + | |
- | + | ||
- | //Do I need to edit these entities* files?// | + | |
- | * No, these are auto-generated by the configure process | + | |
- | * Examples: entities/ | + | |
- | * Also, do not commit them | + | |
- | + | ||
- | // How do I create a patch? // | + | |
- | * In the command-line, | + | |
- | * cd / | + | |
- | * To diff the entire repository: **svn diff** | + | |
- | * To diff a single file: **svn diff foo.xml** | + | |
- | * Consider piping the diff to a file, so: **svn diff foo.xml > mypatch.txt** | + | |
- | + | ||
- | // How do I apply a patch? // | + | |
- | * Assuming the file with the patch is named apatch.txt | + | |
- | * Go to the directory with the files to be patched | + | |
- | * And run this command: **patch -p0 < apatch.txt** | + | |
- | + | ||
- | // Is there an online editor? // | + | |
- | * Yes and No. | + | |
- | * Yes one exists in SVN and is being worked on. | + | |
- | * No it's not yet in use. | + | |
- | * Demo: http:// | + |
doc/howto/faq.1252458407.txt.gz · Last modified: 2017/09/22 13:28 (external edit)