Giter Club home page Giter Club logo

web-php's People

Contributors

alindeman avatar bjori avatar carusogabriel avatar cmb69 avatar db- avatar derickr avatar dragoonis avatar dsp avatar eliw avatar jacques avatar jimwins avatar johannes avatar kaplanlior avatar krakjoe avatar lawngnome avatar localheinz avatar morrisonlevi avatar nunoplopes avatar philip avatar remicollet avatar rlerdorf avatar salathe avatar scoates avatar sgolemon avatar smalyshev avatar sobak avatar stigsb avatar tyrael avatar weltling avatar zsuraski avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

nessworthy

web-php's Issues

Syntax highlighting without inline styles

Discussion points:

  • Client Side vs Server Side
  • Choice of Library

Other points to consider:

  • User comments and documentation use different highlighters, ideally these will want to be highlighted using the same source.

Add copy-example-to-clipboard button

Copying to the clipboard can be done in modern browsers with JavaScript's document.execCommand('copy', ...) which will copy the current selection. I'm not sure the way to feature detect support.

Essentially when a user clicks the button we need to highlight the code snippet and then copy it.

"throws" in function/method synopsis, like return

Currently:

public string Qux::foo( string $baz , string $bar )

Should be (kinda):

public function /* Qux:: */ foo(string $baz , string $bar) : string, throws WhateverException;

It's often hard to figure out (or it's even not specified) that methods throw.
Exceptions aren't less important than return, so they must be documented just as well.

Clean up manual-lookup.sqlite

The mechanism that generates manual-lookup.sqlite is old and somewhat broken.

For example, for APIs with both OOP/procedural commands, it does not find the procedural variant. For example, it finds mysqli::select_db() but not mysqli_select_db().

It's been a long time since I looked into it, but I vaguely also remember other problems and concerns.

Remove synopsis code that is not php

public string getErrorMessage ( void ) 

should be converted to

public function getErrorMessage(): string

or even brackets around optional parameters, etc.

The php syntax alone is enough to describe itself, there is no need for stuff that belongs to other languages. In fact, i'm sure that the manual syntax not matching php's, makes thing more difficult for novices.

Threaded user notes

The current user notes contain people starting their notes with: "In response to", "to clarify foo's message" etc.

Maybe we can provide a way to actually reply to an existing user note and either have levels or some either way to display the relation to the parent.

Distinguish between core and PECL extensions in the Manual

Hi,

that's @nikic's idea but I think it's good and deserves to be discussed here:

A somewhat related point: The manual currently does not really distinguish
between core extensions and PECL extensions. The only real indication you
get is a small (PECL xxx >= yyy) in the version line, otherwise it might as
well be a core function. This is suboptimal, because a very large fraction
of PHP developers is limited to the use of core extensions, and it's not
possible to see at a glance which is which. I'd like to see a much larger
distinction here. "Large" on the order of switching the header from green
to blue and replacing the "php" logo with "pecl".

http://news.php.net/php.doc/969386436

For now, let's assume it's possible on the side of docs rendering (I think it actually is). What do you think? If you think a general idea is good, how should it be implemented?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.