f3-factory / f3com

This is the base system of fat-free framework website / wiki.

F3com

This repository contains the fatfreeframework.com website / wiki.

Installation

First of all install required dependencies via Composer: composer install

The project consists of two different repositories. One with the code, another with the data. To clone both use the following command

git clone --recursive [email protected]:F3Community/F3com.git

Use the following command to get the content from an existing "code" repository

git submodule update --init

Additionally if you wish to run this in the local php development server, do the following:

php -S localhost:8000 .router.php

f3com's Issues

preflight all new written content

We try our best to write clear and understandable, but it's always better to have a native speaker that can check for spelling mistakes or weird sentences.

API Docs: Template

complete the api reference for Template class.

• write something about, how the template class works (prerendering, auto refresh, mime types)
• Mention the usage of custom template tags ( maybe links to examples )

API Docs: Cursor

Please check that page, if it's okay like this.

I was not sure about how to start describing the F3 ORMs.. so i created the cursor page that describes all methods that works for all ORMs. I think some specific things like $filter array syntax, virtual fields and so on belongs to their own ORM specific page, but we do not need to describe all these function from cursor once again on the other pages now. (except some special ones)

API Docs: Prefab

The Prefab class does not really contain that much methods, but it's a good point to say something about using this class and creating custom plugins in general.

API Docs: Audit

complete the api reference for Audit class

API Docs: Cache

complete the api reference for Cache class

API Docs: JIG ORM

• $filter and $options syntax
• preg_match and isset() $filter usage examples

API Docs: MONGO ORM

• basic examples for $filter and $option
• example how to search for MongoId or using MongoRegex
• btw: there is no sum() equivalent, and using the mapper for this does not work. see here

API Docs: Image

complete the api reference for Image class

API Docs: SQL ORM

• $filter and $options array syntax
• virtual fields (for SUM, avg, etc.)
• additional methods

split repo readme.md into multiple User Guide pages

grab the content from here https://github.com/bcosca/fatfree/blob/master/readme.md

and create extra pages out of the TOC https://github.com/bcosca/fatfree/blob/master/readme.md#table-of-contents
and put them in the User Guide section

Notice: do it step by step and see, if the markdown renders correct, and if some extra lines breaks are needed between paragraphs and code block.

convert the headlines to a higher reasonable level,...
use http://wiki.fatfreeframework.com/routing-engine as an example for a nice conversion

API Docs: Base

complete the api reference for Base class

API Docs: Markdown

complete the api reference for Markdown class

Security issue with .git being publicly accessible

Hey there,

Not exactly sure how to configure the nginx instance for fatfreeframework.com but if you go here https://fatfreeframework.com/.git/config you can download the git config file. I'm sure it's not a big deal, but probably should be blacklisted.

API Docs: Auth

complete the api reference for Auth class

API Docs: UTF

Create the UTF API page.

This is a plugin that offers some multibyte-aware unicode string functions.
I'm not sure if we really need examples to every method in here, because the name is mostly self-describing is usage and the syntax of some funcs is nearly the same like the original php function.

Translated User Guide (Persian, etc...)

Hi,
I before creating an issue in bcosca/fatfree#849 and @xfra35 say to create a new issue in this repository.

We can help you to add Persian language to the fatfreeframework.com or create a Persian-language website to introduce and educate the framework for the Persian-language Web designers and developers .

Documentation for locale selection eeds update

Clarify the selection of locale needs nonn standard - instead of _

For example es-MX instead of es_MX

See https://groups.google.com/forum/#!topic/f3-framework/fGEIuo6SKxk

API Docs: OpenID

create the OpenID API page

API Docs: SMTP

complete the api reference for SMTP class

compose.lock needs an update I think

Was getting an issue with php 8.1 as per f3-factory/fatfree-core#333

Here's a patch. Note, the time I changed is just a bogus time stamp.
diff --git a/composer.lock b/composer.lock

index b25aa81..d158213 100644
--- a/composer.lock
+++ b/composer.lock
@@ -8,16 +8,16 @@
     "packages": [
         {
             "name": "bcosca/fatfree-core",
-            "version": "3.7.3",
+            "version": "3.8.0",
             "source": {
                 "type": "git",
                 "url": "https://github.com/bcosca/fatfree-core.git",
-                "reference": "3e23ae05384b2f830e99c5888b94118819ed948b"
+                "reference": "cdd878db018280369b643fce62f70e55044f9ac4"
             },
             "dist": {
                 "type": "zip",
-                "url": "https://api.github.com/repos/bcosca/fatfree-core/zipball/3e23ae05384b2f830e99c5888b94118819ed948b",
-                "reference": "3e23ae05384b2f830e99c5888b94118819ed948b",
+                "url": "https://api.github.com/repos/bcosca/fatfree-core/zipball/cdd878db018280369b643fce62f70e55044f9ac4",
+                "reference": "cdd878db018280369b643fce62f70e55044f9ac4",
                 "shasum": ""
             },
             "require": {
@@ -37,9 +37,9 @@
             "homepage": "http://fatfreeframework.com/",
             "support": {
                 "issues": "https://github.com/bcosca/fatfree-core/issues",
-                "source": "https://github.com/bcosca/fatfree-core/tree/3.7.3"
+                "source": "https://github.com/bcosca/fatfree-core/tree/3.8.0"
             },
-            "time": "2020-12-13T12:49:39+00:00"
+            "time": "2022-02-15T16:59:01+00:00"
         }
     ],
     "packages-dev": [],
@@ -50,5 +50,5 @@
     "prefer-lowest": false,
     "platform": [],
     "platform-dev": [],
-    "plugin-api-version": "2.0.0"
+    "plugin-api-version": "2.3.0"
 }

Toodles

About page

Rename the /developer page to /about or something like that... say something about the author @bcosca, contributors, and insert the Support and Licensing section from the docs here

Maybe a section for 3rd party plugins or would fit here too. Or we create a 3rd party plugins page and a link to it here.

API Docs: PingBack

create the PingBack API Page.

API Docs: Web

complete the api reference for Web class