Changes: Feed The Beast Wiki:Crafting grid overhaul project

Latest revision as of 13:21, 25 November 2018

Welcome to the Template documentation project.

Warning

The new system will not be backwards compatible, old crafting grids will be automatically converted to the new crafting grids. You are safe to continue to use the current system but please do not modify the old grid templates.

Goals

Increase the implementation of stuff that grids support.
Ease the creation of crafting grid templates.
...and more...

Links

Feed The Beast Wiki:Crafting grid overhaul project/Load times

Progress

[Purge]

100% (25/25)

Preparations

Done. Protect crafting grid templates.

Code

Already done. Code animation.
Done. Code crafting grid controls.

Grid

Done. Style grids.
Done. Create grids template.

Animation

Done. Create crafting grid controls to flip through different crafting recipes.
Done. Create "activate animation" wrapping metatemplate.
Done. Create "activate controls" wrapping metatemplate.

Tooltips

Done. Code support for variables in tooltips.

Ore Dictionary

Done. Create Ore Dictionary template
Done. Create Ore Dictionary activation template
Done. Populate Ore Dictionary

Tanks

Done. Create tanks template.
Done. Tank image truncation script.
Done. Tank image helper.

Crafting Grids

Done. Create "cells" metatemplate for crafting grid creation.
Done. Create "tanks" metatemplate for crafting grid creation.
Done. Create a crafting grid metatemplate.
Done. Recreate all crafting grids.
Done. Create documentation cell.

Cleanup

Done. Move new templates into position.
Done. Bot: Convert old template to new templates.
Done. Unprotect crafting grid templates. Feed The Beast Wiki:Crafting grid overhaul project/Error log
Done. Document templates.
Done. Update templates associated with grids. (Infoboxes)

Crafting grids

[Purge]

100% (42/42)

Done. {{Cg/Alloy Furnace}} creates a crafting grid for the Alloy Furnace.
Done. {{Cg/Alloy Smelter}} creates a crafting grid for the Alloy Smelter.
Done. {{Cg/Assembling Machine}} creates a crafting grid for the Assembling Machine.
Done. {{Cg/Automatic Canning Machine}} creates a crafting grid for the Automatic Canning Machine.
Done. {{Cg/Automatic Wiremill}} creates a crafting grid for the Automatic Wiremill.
Done. {{Cg/Canning Machine}} creates a crafting grid for the Canning Machine.
Done. {{Cg/Carpenter}} creates a crafting grid for the Carpenter.
Done. {{Cg/Centrifuge}} creates a crafting grid for the Centrifuge.
Done. {{Cg/Chemical Reactor}} creates a crafting grid for the Chemical Reactor.
Done. {{Cg/Coke Oven}} creates a crafting grid for the Coke Oven.
Done. {{Cg/Compressor}} creates a crafting grid for the Compressor.
Won't create. Grid/Crafting Table creates a crafting grid for the Crafting Table.
Done. {{Cg/Crafting Table}} creates an alternative crafting grid for the Crafting Table.
Done. {{Cg/Distillation Tower}} creates a crafting grid for the Distillation Tower.
Done. {{Cg/Extractor}} creates a crafting grid for the Extractor.
Done. {{Cg/Furnace}} creates a crafting grid for the Furnace.
Done. {{Cg/Fusion Reactor}} creates a crafting grid for the Fusion Reactor.
Done. {{Cg/Implosion Compressor}} creates a crafting grid for the Implosion Compressor.
Done. {{Cg/Induction Smelter}} creates a crafting grid for the Induction Smelter.
Done. {{Cg/Industrial Blast Furnace}} creates a crafting grid for the Industrial Blast Furnace.
Done. {{Cg/Industrial Centrifuge}} creates a crafting grid for the Industrial Centrifuge.
Done. {{Cg/Industrial Electrolyzer}} creates a crafting grid for the Industrial Electrolyzer.
Done. {{Cg/Industrial Grinder}} creates a crafting grid for the Industrial Grinder.
Done. {{Cg/Industrial Sawmill}} creates a crafting grid for the Industrial Sawmill.
Done. {{Cg/Lathe}} creates a crafting grid for the Lathe.
Done. {{Cg/Liquid Transposer}} creates a crafting grid for the Liquid Transposer.
Done. {{Cg/Macerator}} creates a crafting grid for the Macerator.
Done. {{Cg/Magma Crucible}} creates a crafting grid for the Magma Crucible.
Done. {{Cg/Metal Former}} creates a crafting grid for the Metal Former.
Done. {{Cg/Ore Washing Plant}} creates a crafting grid for the Ore Washing Plant.
Done. {{Cg/Plate Bending Machine}} creates a crafting grid for the Plate Bending Machine.
Done. {{Cg/Plate Cutting Machine}} creates a crafting grid for the Place Cutting Machine.
Done. {{Cg/Powered Furnace}} creates a crafting grid for the Power Furnace.
Done. {{Cg/Pulverizer}} creates a crafting grid for the Pulverizer.
Done. {{Cg/Printing Factory}} creates a crafting grid for the Printing Factory.
Done. {{Cg/Recycler}} creates a crafting grid for the Recycler.
Done. {{Cg/Rolling Machine}} creates a crafting grid for the Rolling Machine.
Done. {{Cg/Sawmill}} creates a crafting grid for the Sawmill.
Done. {{Cg/Squeezer}} creates a crafting grid for the Squeezer.
Done. {{Cg/Thermal Centrifuge}} creates a crafting grid for the Thermal Centrifuge.
Done. {{Cg/Thermionic Fabricator}} creates a crafting grid for the Thermionic Fabricator.
Done. {{Cg/Vacuum Freezer}} creates a crafting grid for the Vacuum Freezer.

Crafting grids documentation

[Purge]

100% (42/42)

Done. {{Cg/Alloy Furnace/doc}} creates a crafting grid for the Alloy Furnace.
Done. {{Cg/Alloy Smelter/doc}} creates a crafting grid for the Allow Smelter.
Done. {{Cg/Assembling Machine/doc}} creates a crafting grid for the Assembling Machine.
Done. {{Cg/Automatic Canning Machine/doc}} creates a crafting grid for the Automatic Canning Machine.
Done. {{Cg/Automatic Wiremill/doc}} creates a crafting grid for the Automatic Wiremill.
Done. {{Cg/Canning Machine/doc}} creates a crafting grid for the Canning Machine.
Done. {{Cg/Carpenter/doc}} creates a crafting grid for the Carpenter.
Done. {{Cg/Centrifuge/doc}} creates a crafting grid for the Centrifuge.
Done. {{Cg/Chemical Reactor/doc}} creates a crafting grid for the Chemical Reactor.
Done. {{Cg/Coke Oven/doc}} creates a crafting grid for the Coke Oven.
Done. {{Cg/Compressor/doc}} creates a crafting grid for the Compressor.
Won't create. ~~Cg/Crafting Table/doc creates a crafting grid for the Crafting Table.~~
Done. {{Cg/Crafting Table/doc}} creates an alternative crafting grid for the Crafting Table.
Done. {{Cg/Distillation Tower/doc}} creates a crafting grid for the Distillation Tower.
Done. {{Cg/Extractor/doc}} creates a crafting grid for the Extractor.
Done. {{Cg/Furnace/doc}} creates a crafting grid for the Furnace.
Done. {{Cg/Fusion Reactor/doc}} creates a crafting grid for the Fusion Reactor.
Done. {{Cg/Implosion Compressor/doc}} creates a crafting grid for the Implosion Compressor.
Done. {{Cg/Induction Smelter/doc}} creates a crafting grid for the Induction Smelter.
Done. {{Cg/Industrial Blast Furnace/doc}} creates a crafting grid for the Industrial Blast Furnace.
Done. {{Cg/Industrial Centrifuge/doc}} creates a crafting grid for the Industrial Centrifuge.
Done. {{Cg/Industrial Electrolyzer/doc}} creates a crafting grid for the Industrial Electrolyzer.
Done. {{Cg/Industrial Grinder/doc}} creates a crafting grid for the Industrial Grinder.
Done. {{Cg/Industrial Sawmill/doc}} creates a crafting grid for the Industrial Sawmill.
Done. {{Cg/Lathe/doc}} creates a crafting grid for the Lathe.
Done. {{Cg/Liquid Transposer/doc}} creates a crafting grid for the Liquid Transposer.
Done. {{Cg/Macerator/doc}} creates a crafting grid for the Macerator.
Done. {{Cg/Magma Crucible/doc}} creates a crafting grid for the Magma Crucible.
Done. {{Cg/Metal Former/doc}} creates a crafting grid for the Metal Former.
Done. {{Cg/Ore Washing Plant/doc}} creates a crafting grid for the Ore Washing Plant.
Done. {{Cg/Plate Bending Machine/doc}} creates a crafting grid for the Plate Bending Machine.
Done. {{Cg/Plate Cutting Machine/doc}} creates a crafting grid for the Place Cutting Machine.
Done. {{Cg/Powered Furnace/doc}} creates a crafting grid for the Power Furnace.
Done. {{Cg/Pulverizer/doc}} creates a crafting grid for the Pulverizer.
Done. {{Cg/Printing Factory/doc}} creates a crafting grid for the Printing Factory.
Done. {{Cg/Recycler/doc}} creates an alternative crafting grid for the Recycler.
Done. {{Cg/Rolling Machine/doc}} creates a crafting grid for the Rolling Machine.
Done. {{Cg/Sawmill/doc}} creates a crafting grid for the Sawmill.
Done. {{Cg/Squeezer/doc}} creates a crafting grid for the Squeezer.
Done. {{Cg/Thermal Centrifuge/doc}} creates a crafting grid for the Thermal Centrifuge.
Done. {{Cg/Thermionic Fabricator/doc}} creates a crafting grid for the Thermionic Fabricator.
Done. {{Cg/Vacuum Freezer/doc}} creates a crafting grid for the Vacuum Freezer.

Scope

Crafting grids and related templates.

Project Members

Please add your name to the list if you wish to participate in this project.

Jinbobo (Project leader)

Template list

This is a list of experimental and final templates that the project is currently using.

Experimental templates

{{X1}} -
{{X2}} -
{{X3}} -
{{X4}} -
{{X5}} -
{{X6}} -
{{X7}} -
{{X8}} -
{{X9}} -

Final templates

Documented. {{G}} - Main grid wrapper.
Documented. {{Cg}} - Crafting grid components.
Deprecated. {{G/Dict}} - Ore Dictionary.
Documented. {{G/T}} > {{G/Tank}} - Single tank wrapper.
Documented. {{Gc}} > {{G/Cell}} - Grid display logic.
Documented. {{Gcd}} > {{G/Cell doc}} - Documentation cell
Documented. {{I}} - Creates a image wrapped in the span tag, used in crafting grids.
Documented. {{N}} - Animation/slideshow wrapper
Documented. {{O}} > {{G/O}} - Ore dictionary wrapper, call by tag.
Documented. {{S}} - Creates a string wrapped in the span tag, used in crafting grids.
Documented. {{T}} - Liquid display logic, used in crafting grids.

Prototypes

Working prototypes

Future code example

Single crafting grids

This is what the code to create single crafting grids will look like in the future.

{{Furnace
 |I={{G|Oak Wood}}
 |O={{G|Charcoal}}
 |F={{G|Oak Wood Planks|tooltiptext=$1<br><span class="tcAspectTooltipDesc">Can smelt 1.5 items.</span>}}
}}

Code Explanation

Line 1: No more Grid/ prefix in front of crafting grid templates.
Line 2-4: Instead of providing a list of items to the crafting grid template, you give it a list of grids that can be fully customized. A redirect will be made for less typing (G->Grid).
{{G|Oak Wood}} and {{G|Oak Wood Planks|...}}: A animation will display ore dict compatible items.
{{G|Oak Wood Planks|tooltiptext=$1<br><span class="tcAspectTooltipDesc">Can smelt 1.5 items.</span>}}: Demonstrates that grids in crafting grids can be fully customized. And that tooltips will support variables.

Multiple crafting grids

This is what the code to create multiple crafting grids will look like in the future. Instead of flipping through animations automatically by the script, the user must flip through them manually with the controls provided.

{{Furnace
 |I={{G|Oak Wood|16}}{{G|Clay|9}}
 |O={{G|Charcoal|16}}{{G|Brick|9}}
 |F={{G|Charcoal|2|tooltiptext=Charcoal<br><span class="tcAspectTooltipDesc">Can smelt 8 items.</span>}}{{G|Oak Wood Planks|6|tooltiptext=$1<br><span class="tcAspectTooltipDesc">Can smelt 1.5 items.</span>}}
}}

Crafting grid creation

This is an example of how crafting grids will be created in the future. Ideally, templates used here should be substituted to allow for shallower expansion depth, however, by not substituting the templates you increase the maintainability of these crafting grids.

{{Crafting grid/Start}}
{{Crafting grid/Image|Link to image|style=Additional styles|class=Additional classes}}
{{Crafting grid/Cell|{{{1|{{{A1}}} }}}|X position|Y position|style=Additional styles|class=Additional classes}}
...
{{Crafting grid/Cell|{{{9|{{{C3}}} }}}|X position|Y position|style=Additional styles|class=Additional classes}}
...
{{Crafting grid/Tank|{{{liquid}}}|X position|Y position|style=Additional styles|class=Additional classes}}
{{Crafting grid/End}}

@@ Line 5: / Line 5: @@
 == Goals ==
-* Remove the animation frames limit
-* Introduce oreDict support.
 * Increase the implementation of stuff that grids support.
-* Improve the readability of templates in articles.
 * Ease the creation of crafting grid templates.
 * ...and more...
@@ Line 16: / Line 13: @@
 == Progress ==
-</noinclude><div class="plainlinks" style="text-align:right">'''[http://wiki.feed-the-beast.com/index.php?title={{FULLPAGENAMEE}}&action=purge [Purge&#93;]'''</div>
+</noinclude><div class="plainlinks" style="text-align:right">'''[https://ftb.gamepedia.com/index.php?title={{FULLPAGENAMEE}}&action=purge [Purge&#93;]'''</div>
-{{Project:Template documentation project/Progress bar|24|25}}
+{{Project:Template documentation project/Progress bar|25|25}}
 <noinclude>
 === Preparations ===
@@ Line 52: / Line 49: @@
 * {{Status|done|Done.}} Unprotect crafting grid templates. [[{{FULLPAGENAME}}/Error log]]
 * {{Status|done|Done.}} Document templates.
-* {{Status|partlydone|In progress...}} Update templates associated with grids. (Infoboxes)
+* {{Status|done|Done.}} Update templates associated with grids. (Infoboxes)
 == Crafting grids ==
-<div class="plainlinks" style="text-align:right">'''[http://wiki.feed-the-beast.com/index.php?title={{FULLPAGENAMEE}}&action=purge [Purge&#93;]'''</div>
+<div class="plainlinks" style="text-align:right">'''[https://ftb.gamepedia.com/index.php?title={{FULLPAGENAMEE}}&action=purge [Purge&#93;]'''</div>
 {{Project:Template documentation project/Progress bar|42|42}}
 * {{Status|done|Done.}} {{Tl|Cg/Alloy Furnace}} creates a crafting grid for the [[Alloy Furnace]].
-* {{Status|done|Done.}} {{Tl|Cg/Alloy Smelter}} creates a crafting grid for the [[Allow Smelter]].
+* {{Status|done|Done.}} {{Tl|Cg/Alloy Smelter}} creates a crafting grid for the [[Alloy Smelter]].
 * {{Status|done|Done.}} {{Tl|Cg/Assembling Machine}} creates a crafting grid for the [[Assembling Machine]].
 * {{Status|done|Done.}} {{Tl|Cg/Automatic Canning Machine}} creates a crafting grid for the [[Automatic Canning Machine]].
@@ Line 68: / Line 65: @@
 * {{Status|done|Done.}} {{Tl|Cg/Coke Oven}} creates a crafting grid for the [[Coke Oven]].
 * {{Status|done|Done.}} {{Tl|Cg/Compressor}} creates a crafting grid for the [[Compressor]].
-* <s>{{Status|notdone|Won't create.}} {{Tl|Grid/Crafting Table}} creates a crafting grid for the [[Crafting Table]].</s>
+* <s>{{Status|notdone|Won't create.}} Grid/Crafting Table creates a crafting grid for the [[Crafting Table]].</s>
 * {{Status|done|Done.}} {{Tl|Cg/Crafting Table}} creates an alternative crafting grid for the [[Crafting Table]].
 * {{Status|done|Done.}} {{Tl|Cg/Distillation Tower}} creates a crafting grid for the [[Distillation Tower]].
@@ Line 101: / Line 98: @@
 == Crafting grids documentation ==
-<div class="plainlinks" style="text-align:right">'''[http://wiki.feed-the-beast.com/index.php?title={{FULLPAGENAMEE}}&action=purge [Purge&#93;]'''</div>
+<div class="plainlinks" style="text-align:right">'''[https://ftb.gamepedia.com/index.php?title={{FULLPAGENAMEE}}&action=purge [Purge&#93;]'''</div>
 {{Project:Template documentation project/Progress bar|42|42}}
 * {{Status|done|Done.}} {{Tl|Cg/Alloy Furnace/doc}} creates a crafting grid for the [[Alloy Furnace]].
@@ Line 114: / Line 111: @@
 * {{Status|done|Done.}} {{Tl|Cg/Coke Oven/doc}} creates a crafting grid for the [[Coke Oven]].
 * {{Status|done|Done.}} {{Tl|Cg/Compressor/doc}} creates a crafting grid for the [[Compressor]].
-* {{Status|notdone|Won't create.}} <s>{{Tl|Cg/Crafting Table/doc}} creates a crafting grid for the [[Crafting Table]].</s>
+* {{Status|notdone|Won't create.}} <s>Cg/Crafting Table/doc creates a crafting grid for the [[Crafting Table]].</s>
 * {{Status|done|Done.}} {{Tl|Cg/Crafting Table/doc}} creates an alternative crafting grid for the [[Crafting Table]].
 * {{Status|done|Done.}} {{Tl|Cg/Distillation Tower/doc}} creates a crafting grid for the [[Distillation Tower]].
@@ Line 170: / Line 167: @@
 * {{Status|done|Documented.}} {{Tl|Cg}} - Crafting grid components.
 * {{Status|notdone|Deprecated.}} {{Tl|G/Dict}} - Ore Dictionary.
-* {{Status|done|Documented.}} {{Tl|G/Mods}} - Resolves mod names.
 * {{Status|done|Documented.}} {{Tl|G/T}} > {{Tl|G/Tank}} - Single tank wrapper.
 * {{Status|done|Documented.}} {{Tl|Gc}} > {{Tl|G/Cell}} - Grid display logic.
@@ Line 194: / Line 190: @@
 </pre>
 ===== Code Explanation =====
-* Line 1: No more <tt>Grid/</tt> prefix in front of crafting grid templates.
+* Line 1: No more <code>Grid/</code> prefix in front of crafting grid templates.
 * Line 2-4: Instead of providing a list of items to the crafting grid template, you give it a list of grids that can be fully customized. A redirect will be made for less typing (G->Grid).
-* <tt><nowiki>{{G|Oak Wood}}</nowiki></tt> and <tt><nowiki>{{G|Oak Wood Planks|...}}</nowiki></tt>: A animation will display ore dict compatible items.
+* <code><nowiki>{{G|Oak Wood}}</nowiki></code> and <code><nowiki>{{G|Oak Wood Planks|...}}</nowiki></code>: A animation will display ore dict compatible items.
-* <tt><nowiki>{{G|Oak Wood Planks|tooltiptext=$1<br><span class="tcAspectTooltipDesc">Can smelt 1.5 items.</span>}}</nowiki></tt>: Demonstrates that grids in crafting grids can be fully customized. And that tooltips will support variables.
+* <code><nowiki>{{G|Oak Wood Planks|tooltiptext=$1<br><span class="tcAspectTooltipDesc">Can smelt 1.5 items.</span>}}</nowiki></code>: Demonstrates that grids in crafting grids can be fully customized. And that tooltips will support variables.
 ==== Multiple crafting grids ====
 This is what the code to create multiple crafting grids will look like in the future. Instead of flipping through animations automatically by the script, the user must flip through them manually with the controls provided.
@@ Line 219: / Line 215: @@
 {{Crafting grid/End}}
 </pre>
+{{Navbox portals}}
+[[Category:Projects]]
 </noinclude>