Giter VIP home page Giter VIP logo

documentation's Introduction

Themosis framework

Build Status

The Themosis framework is a tool aimed to WordPress developers of any levels. But the better WordPress and PHP knowledge you have the easier it is to work with.

Themosis framework is a tool to help you develop websites and web applications faster using WordPress. Using an elegant and simple code syntax, Themosis framework helps you structure and organize your code and allows you to better manage and scale your WordPress websites and applications.

Installation

Please see the installation section of the Themosis documentation.

Development team

The framework was created by Julien Lambé, who continues to lead the development.

Contributing

Any help is appreciated. The project is open-source and we encourage you to participate. You can contribute to the project in multiple ways by:

  • Reporting a bug issue
  • Suggesting features
  • Sending a pull request with code fix or feature
  • Following the project on GitHub
  • Following us on Twitter: @Themosis
  • Sharing the project around your community

For details about contributing to the framework, please check the contribution guide.

License

The Themosis framework is open-source software licensed under GPL-2+ license.

documentation's People

Contributors

ben-sharp avatar benceszalai avatar edwinsiebel avatar fabianmarz avatar fr6 avatar hyra avatar jaspervv avatar jbfournot avatar jlambe avatar jminguely avatar jozan avatar lukechilds avatar marcwieland95 avatar nathanaelphilip avatar npsouza avatar ramon-villain avatar roccohoward avatar rumur avatar tisseur2toile avatar xynnn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

documentation's Issues

color of code div's

please make that color to something readable, i think #fff is good.

pre.prettyprint {
...
color:#fff;
}

thanks

Multisite documentation 2.0

The subdomain installation has still a core issue regarding the management of the home_url database option value where it appends the cms URI.

Update the documentation to warn developers to manually update the database and fix the home_url value by removing the cms URI.

Add Metabox "can()" method

Metabox API has a can() method that developers can use in order to limit the display of the metabox based on a role or capability.

// Metabox is viewed only by administrator...
Metabox::make('My Metabox for admin', 'page')->set()->can('administrator');

Service providers guide

Add service providers documentation. How to best write service providers, how to register them.

PLugin define key in supports.config.php theme

I don't know for not display this message :

Your application do not handle the following plugin:

Inside the file, "Define your plugin theme support key. Once defined, make sure to add the key into your theme supports.config.php in order to remove this admin notice"

In the documentation is not really clear

Fix form options documentation

The first parameter of a form is a DTO object. Form options need to be specified as a second argument on the factory make method.

Ajax::listen not working for me

Please help me. I can't make ajax form with Themosis framework. admin-ajax php 200 OK
What is the problem? I make anything wrong?
Thanx for you.

resources/admin/ajax.php
Ajax::run('send_contact_mail', 'both', function(){
echo 'assad';
die();
});

javascript file:
$.ajax({
url: themosis.ajaxurl,
type: 'POST',
dataType: 'json',
data: {
action: 'send_contact_mail',
}
})
.done(function(data) {
console.log(data);
});

Update Taxonomy Documentation to Reflect Changes from 2.0

Hey, I have been using the Beta2 release of 2.0 and have been loving the changes so far.

However: it appears that the Taxonomy documentation has not been updated yet, while the interface for (at least) adding custom fields has clearly changed (with the removal of the addFields method and inclusion of the TaxField class).

It would be great to get clear documentation on this as the examples currently available are broken.

Thanks and keep up the great work!

Theme guide

Add documentation regarding the new default theme.

Add information about GulpJS and WebPack configurations, BrowserSync, Bower, ...

Fix upgrade guide

The theme constant in the upgrade guide is wrong, people should replace with THEME_TEXTDOMAIN

Confused with the views share

Hi! I am a bit confused with the views share.

Where do i place this? in the routes? inside a route?

Can you give an example of how to use it in a route? and where to place it?

Valet documentation

Hi Julien

First, thanks for your great work. Currently I'm developing my first project using Themosis, but when I read about use Homestead honestly I consider another way in roadmap, because "a machine inside machine" is very noise.

Please consider use Valet, for Mac developers. Valet is very simple and robust, recommended by Laravel, or another environments, for example: LocalWP (formerly Local by Flywheel) that's sound like available for Mac an PC users.

Now, if your framework supports Valet, do you have docs? In another issue, I'm read about php artisan serve, but the problem was ugliest url's, Valet solve it.

You can consider another documentation that not uses Homestead, too.

EDIT: Currently I'm running on Mac without Homestead using brew for install PHP/MySQL/nginx, and DBngin to manage SQL environments and Tableplus to manage databases.

Excuse my english and please use Valet :)

Plugin Documentation Access

Hey Themosis Team,
Don't know where I have to post this, but i can't access to the "Plugin" documentation (link) the following message is displayed

Error establishing a database connection

Same message for the pages "wp-cli", "Multisite" and "Theme"

incorrect path on Extending Twig

Hello,

The path for Facades\Twig in example from Extending Twig is incorrect;

Incorrect (Facade)

use Themosis\Support\Facade\Twig;

Correct (Facades)

use Themosis\Support\Facades\Twig;

I hope to be helping

Roadmap for documentation to do

I see you've added alot of new stuff in the dev-master especially the Helper class has been growed significantly. If you would like some help with documenting stuff Im willing to help you. If you are looking for some help, it would be easier for others if you could setup some list with "stuff to document'.

Custom Fields

Great work on this, very awesome.

How would you guys suggest working with Custom Post Types that require multiple custom fields? Creating a proper Model for it would make the most sense, but this doesn't seem to support custom fields.

I was considering going with the "traditional" Pods plugin and see if the Model can still read from these, but maybe there's better practices in place already.

Thanks!

How To Consume Data When Passing In An Include

The docs explain how to pass data along with an include:

@include('header', ['title' => 'Documentation'])

...but, they don't explain how to consume that data in the included view.

header.scout.php

{{ title }} //Use of undefined constant title - assumed 'title'
{{ $title }} //Undefined variable: title

Cant' load View from a plugin controller

I can't load the View file from inside the controller method, I have tried this 2 solution and none of them works (I always get a message saying that the view is not found) :

  1. return view('/newsLetter.twig');
  2. return view(themosis_path('plugin.com.plugin.newsletter.resources').'views/newsLetter.twig');

note : the plugin works correctly if I echo the message directly from inside my controller and themosis_path('plugin.com.plugin.newsletter.resources') return a correct path to the plugin resources folder.

Translation

Hi @jlambe I'm ready to translate the documentation into my native language (pt-br), how do you think we could proceed? Something outside Themosis' website, some language selector there or just a branch in this repo? The community is getting bigger everyday, as well as the brazilian devs.

Custom fields api call 404

I'm testing a bit, and i can't seem custom fields to get to work.

My code:

 PT::make('brand', 'Brands', 'brand')
                ->setLabels(['add_new_item' => 'Add a new brand'])
                ->setArguments([
                       'public' => true,
                       'menu_position' => 20,
                       'supports' => ['title', 'editor', 'post-thumbnail'],
                       'rewrite' => false,
                       'query_var' => false
                ])->set();

        Metabox::make('properties', 'brand')
               ->add(Field::text('test'))
               ->set();

The metabox is visible on the edit screen, however the fields do not get loaded.
When inspecting in console we see a 404 error:
Error: Request failed with status code 404

It's trying to do a call to
http://mydomain.dev/wp-api/themosis/v1/metabox/properties?post_id=18 which gives a 404.

Any suggestions on how to fix this?

Thanks

php console serve command

It might be worth documenting the php console serve command, it's a nice alternative if you don't use Homestead.
Here is how Laravel documents it on their Installation page.

Widgets loader

The current widget documentation is missing a call to the load() method in order to fully load the widgets defined in a custom location.

Compile Views in Storage

I have a local version, that has its own compiled view such as:

/storage/views/c5060c6bbe13e3122cb409950a4ba0cdcc9a0f57.php
/storage/views/fff12666fb99ee057204a844e9ac50b527325a15.php

But when I load the repository in the server, files inside /storage/views/ are omitted.
I've seen this is an issue that is being addressed on future relases. So I copied the compiled views from my local repo into the server. But then I realized on the server's log, themosis is looking for a different compiled file of the views:

PHP Warning:  include(): Failed opening '/storage/views//84d3c649c9572fb2fa35f17823df232ec7101557.php'

This means the hash generated is different on the server than on my local version. I do not care to mantain the hash from local to the server. But I would like for themosis to recompile the views. Is there a command to recompile the views?

Configuration Mistake

The configuration page has the following:

Let's grab all properties of the theme's theme.config.php file:

$all = Config::get('application');

Based on the explanation that comes after (the above code producing an exception in a fresh install) I believe it should be:

$all = Config::get('theme');

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.