From 643f6567809a82a00758da0842de6f7d33bce820 Mon Sep 17 00:00:00 2001 From: Allen Webster Date: Mon, 10 Jul 2017 12:29:14 -0400 Subject: [PATCH] added END_SECTION to site source materials --- 4ed_defines.h | 11 ++-- meta/4ed_meta_defines.h | 11 ++-- platform_win32/win32_gl.h | 11 ++-- site/4ed_sitegen.cpp | 2 - site/source_material/binding_list.txt | 4 ++ site/source_material/docs.txt | 79 +++++++++++++++++++++++++++ site/source_material/feature_list.txt | 8 ++- site/source_material/roadmap.txt | 5 +- string/4coder_string_build_num.txt | 2 +- 9 files changed, 116 insertions(+), 17 deletions(-) create mode 100644 site/source_material/docs.txt diff --git a/4ed_defines.h b/4ed_defines.h index 3fe56aa9..0a80c4a3 100644 --- a/4ed_defines.h +++ b/4ed_defines.h @@ -1,8 +1,11 @@ /* -4tech_defines.h - Standard defines across all 4tech projects. -By Allen Webster -Created 21.01.2017 (dd.mm.yyyy) -*/ + * Mr. 4th Dimention - Allen Webster + * + * 21.01.2017 + * + * Standard defines across 4coder code base. + * + */ // TOP diff --git a/meta/4ed_meta_defines.h b/meta/4ed_meta_defines.h index b8f14468..9004857c 100644 --- a/meta/4ed_meta_defines.h +++ b/meta/4ed_meta_defines.h @@ -1,8 +1,11 @@ /* -4tech_meta_defines.h - Header to setup metaprograms. -By Allen Webster -Created 21.01.2017 (dd.mm.yyyy) -*/ + * Mr. 4th Dimention - Allen Webster + * + * 21.01.2017 + * + * Header to setup metaprograms. + * + */ // TOP diff --git a/platform_win32/win32_gl.h b/platform_win32/win32_gl.h index 2ba985ed..dcb3dfb1 100644 --- a/platform_win32/win32_gl.h +++ b/platform_win32/win32_gl.h @@ -1,8 +1,11 @@ /* -WGL declarations for 4coder. -By Allen Webster -Created 27.01.2017 (dd.mm.yyyy) -*/ + * Mr. 4th Dimention - Allen Webster + * + * 27.01.2017 + * + * WGL declarations for 4coder. + * + */ // TOP diff --git a/site/4ed_sitegen.cpp b/site/4ed_sitegen.cpp index 6a451c1e..c5073879 100644 --- a/site/4ed_sitegen.cpp +++ b/site/4ed_sitegen.cpp @@ -118,8 +118,6 @@ do_html_output(Document_System *doc_system, char *dst_directory, Abstract_Item * // TODO(allen): replace the documentation declaration system with a straight up enriched text system static Abstract_Item* generate_4coder_docs(Document_System *doc_system, char *code_directory, char *src_directory){ -#define ExpandArray(a) (a), (ArrayCount(a)) - Meta_Unit *custom_types_unit = fm_push_array(Meta_Unit, 1); Meta_Unit *lexer_funcs_unit = fm_push_array(Meta_Unit, 1); Meta_Unit *lexer_types_unit = fm_push_array(Meta_Unit, 1); diff --git a/site/source_material/binding_list.txt b/site/source_material/binding_list.txt index 2af700ed..02647332 100644 --- a/site/source_material/binding_list.txt +++ b/site/source_material/binding_list.txt @@ -66,6 +66,7 @@ The following bindings apply in all situations. \BEGIN_ITEM \BEGIN_STYLE{code} \END_STYLE Launch shell command set in a loaded project \END_ITEM \END_LIST +\END_SECTION \SECTION{4coder Internal Command} Long name commands that can be typed in after \BEGIN_STYLE{code} \END_STYLE for infrequently triggered commands. @@ -81,6 +82,7 @@ Long name commands that can be typed in after \BEGIN_STYLE{code} \END_ST \BEGIN_ITEM \BEGIN_STYLE{code} "nix lines" \END_STYLE Switch the bufer to 'nix' line ending mode LF \END_ITEM \END_LIST +\END_SECTION \SECTION{Text File Bindings} The following bindings apply in general text files and most apply in code files, but some are overriden by other commands. @@ -155,6 +157,7 @@ The following bindings apply in general text files and most apply in code files, \BEGIN_ITEM \BEGIN_STYLE{code} \END_STYLE Like previous command but tries to open the jump location in the view that currently holds the jump location list \END_ITEM \END_LIST +\END_SECTION \SECTION{Code File Bindings} The following commands only apply in C/C++ files where the lexer (syntax highlighting) is turned on. @@ -186,3 +189,4 @@ The following commands only apply in C/C++ files where the lexer (syntax highlig \BEGIN_ITEM \BEGIN_STYLE{code} \END_STYLE List all function signatures in the current buffer \END_ITEM \END_LIST +\END_SECTION \ No newline at end of file diff --git a/site/source_material/docs.txt b/site/source_material/docs.txt new file mode 100644 index 00000000..655c6ceb --- /dev/null +++ b/site/source_material/docs.txt @@ -0,0 +1,79 @@ + +\META_PARSE{custom_funcs}{4ed_api_implementation.cpp} +\META_PARSE{custom_types}{4coder_API/types.h} +\META_PARSE{string} {string/internal_4coder_string.cpp} +\META_PARSE{lexer_funcs} {4cpp/4cpp_lexer.h} +\META_PARSE{lexer_types} {4cpp/4cpp_lexer_types.h} + +\BEGIN_LINK{document:home} +\IMAGE{image:4coder_logo}{width:200} +\END_LINK + +\TABLE_OF_CONTENTS + +\SECTION{Introduction} + \SECTION_LINK{introduction} + \INCLUDE{introduction.txt} +\END_SECTION + +\SECTION{4coder Systems} + \SECTION_LINK{4coder_systems} + \TODO +\END_SECTION + +\SECTION{Types and Functions} + \SECTION_LINK{types_and_functions} + + \SECTION{Function List} + \DOC_LIST{custom_funcs} + \END_SECTION + + \SECTION{Type List} + \DOC_LIST{custom_types} + \END_SECTION + + \SECTION{Function Descriptions} + \DOC_FULL{custom_funcs} + \END_SECTION + + \SECTION{Type Descriptions} + \DOC_FULL{custom_types} + \END_SECTION +\END_SECTION + +\SECTION{String Library} + \SECTION{String Library Intro} + \TODO + \END_SECTION + + \SECTION{String Function List} + \DOC_LIST{string} + \END_SECTION + + \SECTION{String Function Descriptions} + \DOC_FULL{string} + \END_SECTION +\END_SECTION + +\SECTION{Lexer Library} + \SECTION{Lexer Intro} + \INCLUDE{lexer_introduction.txt} + \END_SECTION + + \SECTION{Lexer Function List} + \DOC_LIST{lexer_funcs} + \END_SECTION + + \SECTION{Lexer Type List} + \DOC_LIST{lexer_types} + \END_SECTION + + \SECTION{Lexer Function Descriptions} + \DOC_FULL{lexer_funcs} + \END_SECTION + + \SECTION{Lexer Type Descriptions} + \DOC_FULL{lexer_types} + \END_SECTION +\END_SECTION + diff --git a/site/source_material/feature_list.txt b/site/source_material/feature_list.txt index 749d221c..b9ab5e5c 100644 --- a/site/source_material/feature_list.txt +++ b/site/source_material/feature_list.txt @@ -17,6 +17,7 @@ This page provides a list of 4coder features for anyone trying to determine whet \BEGIN_ITEM List all occurences of words in open buffers \END_ITEM \BEGIN_ITEM Clipboard history and "paste-next" to copy multiple chunks of text around easily \END_ITEM \END_LIST +\END_SECTION \SECTION{C/C++ Editing} \BEGIN_LIST @@ -26,6 +27,7 @@ This page provides a list of 4coder features for anyone trying to determine whet \BEGIN_ITEM Run scripts and command line commands in editor \END_ITEM \BEGIN_ITEM Jump to error \END_ITEM \END_LIST +\END_SECTION \SECTION{Project Organization} \BEGIN_LIST @@ -33,6 +35,7 @@ This page provides a list of 4coder features for anyone trying to determine whet \BEGIN_ITEM Set shell/terminal commands to various fkeys for build scripts, test scripts etc \END_ITEM \BEGIN_ITEM project.4coder is a text file so it works painlessly with source control and can it is easy to start working with an existing project on a new machine \END_ITEM \END_LIST +\END_SECTION \SECTION{The Customization API} These features are included in the alpha builds for supporters at the $5 tier and above. @@ -44,6 +47,7 @@ This page provides a list of 4coder features for anyone trying to determine whet \BEGIN_ITEM Access to the code intelligence engine \END_ITEM \BEGIN_ITEM Access to the clipboard \END_ITEM \END_LIST +\END_SECTION \SECTION{The Experimental Features} These features are included in the alpha builds for supporters at the $10 tier and above and are generally only partially implemented, hence not being fully upgraded to the standard build. @@ -55,13 +59,15 @@ This page provides a list of 4coder features for anyone trying to determine whet \BEGIN_ITEM Write in explicit enum values from 0 to n \BEGIN_ITEM Scope aware features: scope navigation & scope absorb down \END_LIST +\END_SECTION \SECTION{Transition From Emacs} 4coder's current setup and editing paradigm is modeled after emacs, so it is very natural to transition to 4coder from emacs for many users. 4coder customization is quite different from emacs though, so anyone who wants to keep their current keybinds will have to take the time to rewrite the keybinding code. Once the initial transition is done, any user who prefers C++ to Lisp will have a much better time in their 4coder configuration code. +\END_SECTION \SECTION{Transition From Vim} For vim users the built-in editing paradigm will not line up with editing habits, but thanks to the open customization model, a vim paradigm and default vim key bindings can be used in 4coder. The vim customization \BEGIN_LINK{!https://github.com/Chronister/4vim} here \END_LINK is an early example of this with many basic vim systems up and running. Right now 4coder is admittedly not great for vim users, but the transition path exists so keep your eyes on 4coder as better vim emulation is still on the way. - +\END_SECTION diff --git a/site/source_material/roadmap.txt b/site/source_material/roadmap.txt index 812ff482..1e4680bf 100644 --- a/site/source_material/roadmap.txt +++ b/site/source_material/roadmap.txt @@ -13,6 +13,7 @@ Right now I am working on upgrading some core internal systems that should buy m \BEGIN_ITEM Fix up the undo/redo system. \END_ITEM \BEGIN_ITEM Expose undo/redo system in the custom layer. \END_ITEM \END_LIST +\END_SECTION \SECTION{Provide Customizations for Multiple Editing Paradgims} \BEGIN_LIST @@ -20,6 +21,7 @@ Right now I am working on upgrading some core internal systems that should buy m \BEGIN_ITEM Custom layer reloading at runtime. \END_ITEM \BEGIN_ITEM New frameworks for vim like and sublime like editing. \END_ITEM \END_LIST +\END_SECTION \SECTION{Platform Layer Features and Porting Issues} \BEGIN_LIST @@ -27,6 +29,7 @@ Right now I am working on upgrading some core internal systems that should buy m \BEGIN_ITEM Support for double click opening files in an existing window. \END_ITEM \BEGIN_ITEM Make the rendeirng system modular. \END_ITEM \END_LIST +\END_SECTION \SECTION{Buffer Driven GUI} \BEGIN_LIST @@ -34,4 +37,4 @@ Right now I am working on upgrading some core internal systems that should buy m \BEGIN_ITEM Tables. \END_ITEM \BEGIN_ITEM IMGUI helper wrapper. \END_ITEM \END_LIST - +\END_SECTION diff --git a/string/4coder_string_build_num.txt b/string/4coder_string_build_num.txt index c4fa2f97..5e38390b 100644 --- a/string/4coder_string_build_num.txt +++ b/string/4coder_string_build_num.txt @@ -1,5 +1,5 @@ 1 0 -98 +99