From d448742ae5059ad4aa6e3381b91e4c0e3b9d7766 Mon Sep 17 00:00:00 2001 From: zotlabs Date: Mon, 18 Jun 2018 20:18:29 -0700 Subject: translate dos line endings --- doc/intro_for_developers.bb | 226 ++++++++++++++++++++++---------------------- 1 file changed, 113 insertions(+), 113 deletions(-) (limited to 'doc/intro_for_developers.bb') diff --git a/doc/intro_for_developers.bb b/doc/intro_for_developers.bb index 99dd8f8f3..6ef7a4d9e 100644 --- a/doc/intro_for_developers.bb +++ b/doc/intro_for_developers.bb @@ -1,113 +1,113 @@ -[b]$Projectname Developer Guide[/b] - -[b]File system layout:[/b] - -[addon] optional addons/plugins - -[boot.php] Every process uses this to bootstrap the application structure - -[doc] Help Files - -[images] core required images - -[include] The "model" in MVC - (back-end functions), also contains PHP "executables" for background processing - -[index.php] The front-end controller for web access - -[install] Installation and upgrade files and DB schema - -[library] Third party modules (must be license compatible) - -[mod] Controller modules based on URL pathname (e.g. #^[url=http://sitename/foo]http://sitename/foo[/url] loads mod/foo.php) - -[mod/site/] site-specific mod overrides, excluded from git - -[util] translation tools, main English string database and other miscellaneous utilities - -[version.inc] contains current version (auto-updated via cron for the master repository and distributed via git) - -[view] theming and language files - -[view/(css,js,img,php,tpl)] default theme files - -[view/(en,it,es ...)] language strings and resources - -[view/theme/] individual named themes containing (css,js,img,php,tpl) over-rides - -[b]The Database:[/b] - - [li]abook - contact table, replaces Friendica 'contact'[/li] - [li]account - service provider account[/li] - [li]addon - registered plugins[/li] - [li]app - peronal app data[/li] - [li]attach - file attachments[/li] - [li]auth_codes - OAuth usage[/li] - [li]cache - OEmbed cache[/li] - [li]channel - replaces Friendica 'user'[/li] - [li]chat - chat room content[/li] - [li]chatpresence - channel presence information for chat[/li] - [li]chatroom - data for the actual chat room[/li] - [li]clients - OAuth usage[/li] - [li]config - main configuration storage[/li] - [li]conv - Diaspora private messages[/li] - [li]event - Events[/li] - [li]fcontact - friend suggestion stuff[/li] - [li]ffinder - friend suggestion stuff[/li] - [li]fserver - obsolete[/li] - [li]fsuggest - friend suggestion stuff[/li] - [li]groups - privacy groups[/li] - [li]group_member - privacy groups[/li] - [li]hook - plugin hook registry[/li] - [li]hubloc - Red location storage, ties a location to an xchan[/li] - [li]item - posts[/li] - [li]item_id - other identifiers on other services for posts[/li] - [li]likes - likes of 'things'[/li] - [li]mail - private messages[/li] - [li]menu - channel menu data[/li] - [li]menu_item - items uses by channel menus[/li] - [li]notify - notifications[/li] - [li]notify-threads - need to factor this out and use item thread info on notifications[/li] - [li]obj - object data for things (x has y)[/li] - [li]outq - output queue[/li] - [li]pconfig - personal (per channel) configuration storage[/li] - [li]photo - photo storage[/li] - [li]poll - data for polls[/li] - [li]poll_elm - data for poll elements[/li] - [li]profdef - custom profile field definitions[/li] - [li]profext - custom profile field data[/li] - [li]profile - channel profiles[/li] - [li]profile_check - DFRN remote auth use, may be obsolete[/li] - [li]register - registrations requiring admin approval[/li] - [li]session - web session storage[/li] - [li]shares - shared item information[/li] - [li[sign - Diaspora signatures. To be phased out.[/li] - [li]site - site table to find directory peers[/li] - [li]source - channel sources data[/li] - [li]spam - unfinished[/li] - [li]sys_perms - extensible permissions for the sys channel[/li] - [li]term - item taxonomy (categories, tags, etc.) table[/li] - [li]tokens - OAuth usage[/li] - [li]updates - directory sync updates[/li] - [li]verify - general purpose verification structure[/li] - [li]vote - vote data for polls[/li] - [li]xchan - replaces 'gcontact', list of known channels in the universe[/li] - [li]xchat - bookmarked chat rooms[/li] - [li]xconfig - as pconfig but for channels with no local account[/li] - [li]xlink - "friends of friends" linkages derived from poco[/li] - [li]xprof - if this hub is a directory server, contains basic public profile info of everybody in the network[/li] - [li]xtag - if this hub is a directory server, contains tags or interests of everybody in the network[/li] - - -[b]How to theme $Projectname - by Olivier Migeot[/b] - -This is a short documentation on what I found while trying to modify $Projectname's appearance. - -First, you'll need to create a new theme. This is in /view/theme, and I chose to copy 'redbasic' since it's the only available for now. Let's assume I named it . - -Oh, and don't forget to rename the _init function in /php/theme.php to be _init() instead of redbasic_init(). - -At that point, if you need to add javascript or css files, add them to /js or /css, and then "register" them in _init() through head_add_js('file.js') and head_add_css('file.css'). - -Now you'll probably want to alter a template. These can be found in in /view/tpl OR view//tpl. All you should have to do is copy whatever you want to tweak from the first place to your theme's own tpl directory. - -#include doc/macros/main_footer.bb; +[b]$Projectname Developer Guide[/b] + +[b]File system layout:[/b] + +[addon] optional addons/plugins + +[boot.php] Every process uses this to bootstrap the application structure + +[doc] Help Files + +[images] core required images + +[include] The "model" in MVC - (back-end functions), also contains PHP "executables" for background processing + +[index.php] The front-end controller for web access + +[install] Installation and upgrade files and DB schema + +[library] Third party modules (must be license compatible) + +[mod] Controller modules based on URL pathname (e.g. #^[url=http://sitename/foo]http://sitename/foo[/url] loads mod/foo.php) + +[mod/site/] site-specific mod overrides, excluded from git + +[util] translation tools, main English string database and other miscellaneous utilities + +[version.inc] contains current version (auto-updated via cron for the master repository and distributed via git) + +[view] theming and language files + +[view/(css,js,img,php,tpl)] default theme files + +[view/(en,it,es ...)] language strings and resources + +[view/theme/] individual named themes containing (css,js,img,php,tpl) over-rides + +[b]The Database:[/b] + + [li]abook - contact table, replaces Friendica 'contact'[/li] + [li]account - service provider account[/li] + [li]addon - registered plugins[/li] + [li]app - peronal app data[/li] + [li]attach - file attachments[/li] + [li]auth_codes - OAuth usage[/li] + [li]cache - OEmbed cache[/li] + [li]channel - replaces Friendica 'user'[/li] + [li]chat - chat room content[/li] + [li]chatpresence - channel presence information for chat[/li] + [li]chatroom - data for the actual chat room[/li] + [li]clients - OAuth usage[/li] + [li]config - main configuration storage[/li] + [li]conv - Diaspora private messages[/li] + [li]event - Events[/li] + [li]fcontact - friend suggestion stuff[/li] + [li]ffinder - friend suggestion stuff[/li] + [li]fserver - obsolete[/li] + [li]fsuggest - friend suggestion stuff[/li] + [li]groups - privacy groups[/li] + [li]group_member - privacy groups[/li] + [li]hook - plugin hook registry[/li] + [li]hubloc - Red location storage, ties a location to an xchan[/li] + [li]item - posts[/li] + [li]item_id - other identifiers on other services for posts[/li] + [li]likes - likes of 'things'[/li] + [li]mail - private messages[/li] + [li]menu - channel menu data[/li] + [li]menu_item - items uses by channel menus[/li] + [li]notify - notifications[/li] + [li]notify-threads - need to factor this out and use item thread info on notifications[/li] + [li]obj - object data for things (x has y)[/li] + [li]outq - output queue[/li] + [li]pconfig - personal (per channel) configuration storage[/li] + [li]photo - photo storage[/li] + [li]poll - data for polls[/li] + [li]poll_elm - data for poll elements[/li] + [li]profdef - custom profile field definitions[/li] + [li]profext - custom profile field data[/li] + [li]profile - channel profiles[/li] + [li]profile_check - DFRN remote auth use, may be obsolete[/li] + [li]register - registrations requiring admin approval[/li] + [li]session - web session storage[/li] + [li]shares - shared item information[/li] + [li[sign - Diaspora signatures. To be phased out.[/li] + [li]site - site table to find directory peers[/li] + [li]source - channel sources data[/li] + [li]spam - unfinished[/li] + [li]sys_perms - extensible permissions for the sys channel[/li] + [li]term - item taxonomy (categories, tags, etc.) table[/li] + [li]tokens - OAuth usage[/li] + [li]updates - directory sync updates[/li] + [li]verify - general purpose verification structure[/li] + [li]vote - vote data for polls[/li] + [li]xchan - replaces 'gcontact', list of known channels in the universe[/li] + [li]xchat - bookmarked chat rooms[/li] + [li]xconfig - as pconfig but for channels with no local account[/li] + [li]xlink - "friends of friends" linkages derived from poco[/li] + [li]xprof - if this hub is a directory server, contains basic public profile info of everybody in the network[/li] + [li]xtag - if this hub is a directory server, contains tags or interests of everybody in the network[/li] + + +[b]How to theme $Projectname - by Olivier Migeot[/b] + +This is a short documentation on what I found while trying to modify $Projectname's appearance. + +First, you'll need to create a new theme. This is in /view/theme, and I chose to copy 'redbasic' since it's the only available for now. Let's assume I named it . + +Oh, and don't forget to rename the _init function in /php/theme.php to be _init() instead of redbasic_init(). + +At that point, if you need to add javascript or css files, add them to /js or /css, and then "register" them in _init() through head_add_js('file.js') and head_add_css('file.css'). + +Now you'll probably want to alter a template. These can be found in in /view/tpl OR view//tpl. All you should have to do is copy whatever you want to tweak from the first place to your theme's own tpl directory. + +#include doc/macros/main_footer.bb; -- cgit v1.2.3